Adapter for Integration to Google Cloud Platform Compute
Overview
This adapter is used to integrate the Itential Automation Platform (IAP) with the GcpCompute System. The API that was used to build the adapter for GcpCompute is usually available in the report directory of this adapter. The adapter utilizes the GcpCompute API to provide the integrations that are deemed pertinent to IAP. The ReadMe file is intended to provide information on this adapter it is generated from various other Markdown files.
Details
The Google Cloud Platform Compute adapter from Itential is used to integrate the Itential Automation Platform (IAP) with Google Cloud Platform. With this adapter you have the ability to perform operations such as:
- Configure and Manage Compute Resources in the Google Cloud Platform.
For further technical details on how to install and use this adapter, please click the Technical Documentation tab.
Google Cloud Platform Compute
Table of Contents
Getting Started
These instructions will help you get a copy of the project on your local machine for development and testing. Reading this section is also helpful for deployments as it provides you with pertinent information on prerequisites and properties.
Helpful Background Information
There is Adapter documentation available on the Itential Documentation Site. This documentation includes information and examples that are helpful for:
Authentication
IAP Service Instance Configuration
Code Files
Endpoint Configuration (Action & Schema)
Mock Data
Adapter Generic Methods
Headers
Security
Linting and Testing
Build an Adapter
Troubleshooting an Adapter
Others will be added over time. Want to build a new adapter? Use the Itential Adapter Builder
Prerequisites
The following is a list of required packages for installation on the system the adapter will run on:
Node.js
npm
Git
The following list of packages are required for Itential opensource adapters or custom adapters that have been built utilizing the Itential Adapter Builder. You can install these packages by running npm install inside the adapter directory.
Package | Description |
---|---|
@itentialopensource/adapter-utils | Runtime library classes for all adapters; includes request handling, connection, authentication throttling, and translation. |
ajv | Required for validation of adapter properties to integrate with GcpCompute. |
axios | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
commander | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
dns-lookup-promise | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
fs-extra | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
mocha | Testing library that is utilized by some of the node scripts that are included with the adapter. |
mocha-param | Testing library that is utilized by some of the node scripts that are included with the adapter. |
mongodb | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
nyc | Testing coverage library that is utilized by some of the node scripts that are included with the adapter. |
ping | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
readline-sync | Utilized by the node script that comes with the adapter; helps to test unit and integration functionality. |
semver | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
winston | Utilized by the node scripts that are included with the adapter; helps to build and extend the functionality. |
If you are developing and testing a custom adapter, or have testing capabilities on an Itential opensource adapter, you will need to install these packages as well.
chai
eslint
eslint-config-airbnb-base
eslint-plugin-import
eslint-plugin-json
testdouble
How to Install
- Set up the name space location in your IAP node_modules.
cd /opt/pronghorn/current/node_modules (* could be in a different place)
if the @itentialopensource directory does not exist, create it:
mkdir @itentialopensource
- Clone/unzip/tar the adapter into your IAP environment.
cd \@itentialopensource
git clone git@gitlab.com:\@itentialopensource/adapters/adapter-gcp_compute
or
unzip adapter-gcp_compute.zip
or
tar -xvf adapter-gcp_compute.tar
- Run the adapter install script.
cd adapter-gcp_compute
npm install
npm run lint:errors
npm run test
- Restart IAP
systemctl restart pronghorn
Create an adapter service instance configuration in IAP Admin Essentials GUI
Copy the properties from the sampleProperties.json and paste them into the service instance configuration in the inner/second properties field.
Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
For an easier install of the adapter use npm run adapter:install, it will install the adapter in IAP. Please note that it can be dependent on where the adapter is installed and on the version of IAP so it is subject to fail. If using this, you can replace step 3-5 above with these:
- Install adapter dependencies and check the adapter.
cd adapter-gcp_compute
npm run adapter:install
- Restart IAP
systemctl restart pronghorn
- Change the adapter service instance configuration (host, port, credentials, etc) in IAP Admin Essentials GUI
Testing
Mocha is generally used to test all Itential Opensource Adapters. There are unit tests as well as integration tests performed. Integration tests can generally be run as standalone using mock data and running the adapter in stub mode, or as integrated. When running integrated, every effort is made to prevent environmental failures, however there is still a possibility.
Unit Testing
Unit Testing includes testing basic adapter functionality as well as error conditions that are triggered in the adapter prior to any integration. There are two ways to run unit tests. The prefered method is to use the testRunner script; however, both methods are provided here.
node utils/testRunner --unit
npm run test:unit
npm run test:baseunit
To add new unit tests, edit the test/unit/adapterTestUnit.js
file. The tests that are already in this file should provide guidance for adding additional tests.
Integration Testing - Standalone
Standalone Integration Testing requires mock data to be provided with the entities. If this data is not provided, standalone integration testing will fail. When the adapter is set to run in stub mode (setting the stub property to true), the adapter will run through its code up to the point of making the request. It will then retrieve the mock data and return that as if it had received that data as the response from GcpCompute. It will then translate the data so that the adapter can return the expected response to the rest of the Itential software. Standalone is the default integration test.
Similar to unit testing, there are two ways to run integration tests. Using the testRunner script is better because it prevents you from having to edit the test script; it will also resets information after testing is complete so that credentials are not saved in the file.
node utils/testRunner
answer no at the first prompt
npm run test:integration
To add new integration tests, edit the test/integration/adapterTestIntegration.js
file. The tests that are already in this file should provide guidance for adding additional tests.
Integration Testing
Integration Testing requires connectivity to GcpCompute. By using the testRunner script it prevents you from having to edit the integration test. It also resets the integration test after the test is complete so that credentials are not saved in the file.
Note: These tests have been written as a best effort to make them work in most environments. However, the Adapter Builder often does not have the necessary information that is required to set up valid integration tests. For example, the order of the requests can be very important and data is often required for
creates
andupdates
. Hence, integration tests may have to be enhanced before they will work (integrate) with GcpCompute. Even after tests have been set up properly, it is possible there are environmental constraints that could result in test failures. Some examples of possible environmental issues are customizations that have been made within GcpCompute which change order dependencies or required data.
node utils/testRunner
answer yes at the first prompt
answer all other questions on connectivity and credentials
Test should also be written to clean up after themselves. However, it is important to understand that in some cases this may not be possible. In addition, whenever exceptions occur, test execution may be stopped, which will prevent cleanup actions from running. It is recommended that tests be utilized in dev and test labs only.
Reminder: Do not check in code with actual credentials to systems.
Configuration
This section defines all the properties that are available for the adapter, including detailed information on what each property is for. If you are not using certain capabilities with this adapter, you do not need to define all of the properties. An example of how the properties for this adapter can be used with tests or IAP are provided in the sampleProperties.
Example Properties
"properties": {
"host": "compute.googleapis.com",
"port": 443,
"choosepath": "",
"base_path": "/compute",
"version": "v1",
"cache_location": "none",
"encode_pathvars": true,
"encode_queryvars": true,
"save_metric": false,
"stub": false,
"protocol": "https",
"authentication": {
"auth_method": "no_authentication",
"username": "username",
"password": "password",
"token": "token",
"invalid_token_error": 401,
"token_timeout": 3600000,
"token_cache": "local",
"auth_field": "header.headers.Authorization",
"auth_field_format": "Bearer {token}",
"auth_logging": false,
"client_id": "",
"client_secret": "",
"grant_type": "",
"sensitive": [],
"sso": {
"protocol": "",
"host": "",
"port": 0
},
"multiStepAuthCalls": [
{
"name": "",
"requestFields": {},
"responseFields": {},
"successfullResponseCode": 200
}
],
"configureGtoken": {
"email": "",
"scope": "https://www.googleapis.com/auth/cloud-platform",
"sub": "",
"keyFile": "/opt/pronghorn/RENAME_TO_YOUR_KEYFILE.json",
"key": "",
"additionalClaims": "",
"eagerRefreshThresholdMillis": 300000
}
},
"healthcheck": {
"type": "startup",
"frequency": 600000,
"query_object": {},
"addlHeaders": {}
},
"throttle": {
"throttle_enabled": false,
"number_pronghorns": 1,
"sync_async": "sync",
"max_in_queue": 1000,
"concurrent_max": 1,
"expire_timeout": 0,
"avg_runtime": 200,
"priorities": [
{
"value": 0,
"percent": 100
}
]
},
"request": {
"number_redirects": 0,
"number_retries": 3,
"limit_retry_error": [
0
],
"failover_codes": [],
"attempt_timeout": 5000,
"global_request": {
"payload": {},
"uriOptions": {},
"addlHeaders": {},
"authData": {}
},
"healthcheck_on_timeout": true,
"return_raw": false,
"archiving": false,
"return_request": false
},
"proxy": {
"enabled": false,
"host": "",
"port": 1,
"protocol": "http",
"username": "",
"password": ""
},
"ssl": {
"ecdhCurve": "",
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": "",
"secure_protocol": "",
"ciphers": ""
},
"mongo": {
"host": "",
"port": 0,
"database": "",
"username": "",
"password": "",
"replSet": "",
"db_ssl": {
"enabled": false,
"accept_invalid_cert": false,
"ca_file": "",
"key_file": "",
"cert_file": ""
}
},
"devicebroker": {
"enabled": true,
"getDevice": [
{
"path": "/{project}/global/networks",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "{project}"
},
"responseDatakey": "items",
"responseFields": {
"name": "{name}",
"ostype": "{kind}",
"ostypePrefix": "VPC Network-",
"ipaddress": "{id}",
"port": "{selfLinkWithId}"
}
}
],
"getDevicesFiltered": [
{
"path": "/{project}/global/networks",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "helical-crowbar-382719"
},
"responseDatakey": "items",
"responseFields": {
"name": "{name}",
"ostype": "{kind}",
"ostypePrefix": "VPC Network-",
"ipaddress": "{id}",
"port": "{selfLinkWithId}",
"project": "{project}"
}
}
],
"isAlive": [
{
"path": "/{project}/global/networks/{network}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "{project}",
"network": ""
},
"responseDatakey": "",
"responseFields": {}
}
],
"getConfig": [
{
"path": "/{project}/global/networks/{network}",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "{project}",
"network": ""
},
"responseDatakey": "",
"responseFields": {}
}
],
"getCount": [
{
"path": "/{project}/global/networks",
"method": "GET",
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "helical-crowbar-382719"
},
"responseDatakey": "items",
"responseFields": {}
}
]
},
"cache": {
"enabled": false,
"entities": [
{
"entityType": "device",
"frequency": 3600,
"flushOnFail": false,
"limit": 1000,
"retryAttempts": 5,
"sort": true,
"populate": [
{
"path": "/{project}/global/networks",
"method": "GET",
"pagination": {
"offsetVar": "",
"limitVar": "",
"incrementBy": "limit",
"requestLocation": "query"
},
"query": {},
"body": {},
"headers": {},
"handleFailure": "ignore",
"requestFields": {
"project": "helical-crowbar-382719"
},
"responseDatakey": "items",
"responseFields": {
"name": "{name}",
"ostype": "{kind}",
"ostypePrefix": "VPC Network-",
"ipaddress": "{id}",
"port": "{selfLinkWithId}",
"project": "{project}"
}
}
],
"cachedTasks": [
{
"name": "",
"filterField": "",
"filterLoc": ""
}
]
}
]
}
}
Connection Properties
These base properties are used to connect to GcpCompute upon the adapter initially coming up. It is important to set these properties appropriately.
Property | Description |
---|---|
host | Required. A fully qualified domain name or IP address. |
port | Required. Used to connect to the server. |
base_path | Optional. Used to define part of a path that is consistent for all or most endpoints. It makes the URIs easier to use and maintain but can be overridden on individual calls. An example **base_path** might be `/rest/api`. Default is ``. |
version | Optional. Used to set a global version for action endpoints. This makes it faster to update the adapter when endpoints change. As with the base-path, version can be overridden on individual endpoints. Default is ``. |
cache_location | Optional. Used to define where the adapter cache is located. The cache is used to maintain an entity list to improve performance. Storage locally is lost when the adapter is restarted. Storage in Redis is preserved upon adapter restart. Default is none which means no caching of the entity list. |
encode_pathvars | Optional. Used to tell the adapter to encode path variables or not. The default behavior is to encode them so this property can be used to stop that behavior. |
encode_queryvars | Optional. Used to tell the adapter to encode query parameters or not. The default behavior is to encode them so this property can be used to stop that behavior. |
save_metric | Optional. Used to tell the adapter to save metric information (this does not impact metrics returned on calls). This allows the adapter to gather metrics over time. Metric data can be stored in a database or on the file system. |
stub | Optional. Indicates whether the stub should run instead of making calls to GcpCompute (very useful during basic testing). Default is false (which means connect to GcpCompute). |
protocol | Optional. Notifies the adapter whether to use HTTP or HTTPS. Default is HTTP. |
A connectivity check tells IAP the adapter has loaded successfully.
Authentication Properties
The following properties are used to define the authentication process to GcpCompute.
Note: Depending on the method that is used to authenticate with GcpCompute, you may not need to set all of the authentication properties.
Property | Description |
---|---|
auth_method | Required. Used to define the type of authentication currently supported. Authentication methods currently supported are: `basic user_password`, `static_token`, `request_token`, and `no_authentication`. |
username | Used to authenticate with GcpCompute on every request or when pulling a token that will be used in subsequent requests. |
password | Used to authenticate with GcpCompute on every request or when pulling a token that will be used in subsequent requests. |
token | Defines a static token that can be used on all requests. Only used with `static_token` as an authentication method (auth\_method). |
invalid_token_error | Defines the HTTP error that is received when the token is invalid. Notifies the adapter to pull a new token and retry the request. Default is 401. |
token_timeout | Defines how long a token is valid. Measured in milliseconds. Once a dynamic token is no longer valid, the adapter has to pull a new token. If the token_timeout is set to -1, the adapter will pull a token on every request to GcpCompute. If the timeout_token is 0, the adapter will use the expiration from the token response to determine when the token is no longer valid. |
token_cache | Used to determine where the token should be stored (local memory or in Redis). |
auth_field | Defines the request field the authentication (e.g., token are basic auth credentials) needs to be placed in order for the calls to work. |
auth_field_format | Defines the format of the auth\_field. See examples below. Items enclosed in {} inform the adapter to perofrm an action prior to sending the data. It may be to replace the item with a value or it may be to encode the item. |
auth_logging | Setting this true will add some additional logs but this should only be done when trying to debug an issue as certain credential information may be logged out when this is true. |
client_id | Provide a client id when needed, this is common on some types of OAuth. |
client_secret | Provide a client secret when needed, this is common on some types of OAuth. |
grant_type | Provide a grant type when needed, this is common on some types of OAuth. |
Examples of authentication field format
"{token}"
"Token {token}"
"{username}:{password}"
"Basic {b64}{username}:{password}{/b64}"
Healthcheck Properties
The healthcheck properties defines the API that runs the healthcheck to tell the adapter that it can reach GcpCompute. There are currently three types of healthchecks.
- None - Not recommended. Adapter will not run a healthcheck. Consequently, unable to determine before making a request if the adapter can reach GcpCompute.
- Startup - Adapter will check for connectivity when the adapter initially comes up, but it will not check afterwards.
- Intermittent - Adapter will check connectivity to GcpCompute at a frequency defined in the
frequency
property.
Property | Description |
---|---|
type | Required. The type of health check to run. |
frequency | Required if intermittent. Defines how often the health check should run. Measured in milliseconds. Default is 300000. |
query_object | Query parameters to be added to the adapter healthcheck call. |
Request Properties
The request section defines properties to help handle requests.
Property | Description |
---|---|
number_redirects | Optional. Tells the adapter that the request may be redirected and gives it a maximum number of redirects to allow before returning an error. Default is 0 - no redirects. |
number_retries | Tells the adapter how many times to retry a request that has either aborted or reached a limit error before giving up and returning an error. |
limit_retry_error | Optional. Can be either an integer or an array. Indicates the http error status number to define that no capacity was available and, after waiting a short interval, the adapter can retry the request. If an array is provvided, the array can contain integers or strings. Strings in the array are used to define ranges (e.g. "502-506"). Default is [0]. |
failover_codes | An array of error codes for which the adapter will send back a failover flag to IAP so that the Platform can attempt the action in another adapter. |
attempt_timeout | Optional. Tells how long the adapter should wait before aborting the attempt. On abort, the adapter will do one of two things: 1) return the error; or 2) if **healthcheck\_on\_timeout** is set to true, it will abort the request and run a Healthcheck until it re-establishes connectivity to GcpCompute, and then will re-attempt the request that aborted. Default is 5000 milliseconds. |
global_request | Optional. This is information that the adapter can include in all requests to the other system. This is easier to define and maintain than adding this information in either the code (adapter.js) or the action files. |
global_request -> payload | Optional. Defines any information that should be included on all requests sent to the other system that have a payload/body. |
global_request -> uriOptions | Optional. Defines any information that should be sent as untranslated query options (e.g. page, size) on all requests to the other system. |
global_request -> addlHeaders | Optioonal. Defines any headers that should be sent on all requests to the other system. |
global_request -> authData | Optional. Defines any additional authentication data used to authentice with the other system. This authData needs to be consistent on every request. |
healthcheck_on_timeout | Required. Defines if the adapter should run a health check on timeout. If set to true, the adapter will abort the request and run a health check until it re-establishes connectivity and then it will re-attempt the request. |
return_raw | Optional. Tells the adapter whether the raw response should be returned as well as the IAP response. This is helpful when running integration tests to save mock data. It does add overhead to the response object so it is not ideal from production. |
archiving | Optional flag. Default is false. It archives the request, the results and the various times (wait time, GcpCompute time and overall time) in the `adapterid_results` collection in MongoDB. Although archiving might be desirable, be sure to develop a strategy before enabling this capability. Consider how much to archive and what strategy to use for cleaning up the collection in the database so that it does not become too large, especially if the responses are large. |
return_request | Optional flag. Default is false. Will return the actual request that is made including headers. This should only be used during debugging issues as there could be credentials in the actual request. |
SSL Properties
The SSL section defines the properties utilized for ssl authentication with GcpCompute. SSL can work two different ways: set the accept\_invalid\_certs
flag to true (only recommended for lab environments), or provide a ca\_file
.
Property | Description |
---|---|
enabled | If SSL is required, set to true. |
accept_invalid_certs | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false. |
ca_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required. |
key_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL. |
cert_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL. |
secure_protocol | Defines the protocol (e.g., SSLv3_method) to use on the SSL request. |
ciphers | Required if SSL enabled. Specifies a list of SSL ciphers to use. |
ecdhCurve | During testing on some Node 8 environments, you need to set `ecdhCurve` to auto. If you do not, you will receive PROTO errors when attempting the calls. This is the only usage of this property and to our knowledge it only impacts Node 8 and 9. |
Throttle Properties
The throttle section is used when requests to GcpCompute must be queued (throttled). All of the properties in this section are optional.
Property | Description |
---|---|
throttle_enabled | Default is false. Defines if the adapter should use throttling or not. |
number_pronghorns | Default is 1. Defines if throttling is done in a single Itential instance or whether requests are being throttled across multiple Itential instances (minimum = 1, maximum = 20). Throttling in a single Itential instance uses an in-memory queue so there is less overhead. Throttling across multiple Itential instances requires placing the request and queue information into a shared resource (e.g. database) so that each instance can determine what is running and what is next to run. Throttling across multiple instances requires additional I/O overhead. |
sync-async | This property is not used at the current time (it is for future expansion of the throttling engine). |
max_in_queue | Represents the maximum number of requests the adapter should allow into the queue before rejecting requests (minimum = 1, maximum = 5000). This is not a limit on what the adapter can handle but more about timely responses to requests. The default is currently 1000. |
concurrent_max | Defines the number of requests the adapter can send to GcpCompute at one time (minimum = 1, maximum = 1000). The default is 1 meaning each request must be sent to GcpCompute in a serial manner. |
expire_timeout | Default is 0. Defines a graceful timeout of the request session. After a request has completed, the adapter will wait additional time prior to sending the next request. Measured in milliseconds (minimum = 0, maximum = 60000). |
average_runtime | Represents the approximate average of how long it takes GcpCompute to handle each request. Measured in milliseconds (minimum = 50, maximum = 60000). Default is 200. This metric has performance implications. If the runtime number is set too low, it puts extra burden on the CPU and memory as the requests will continually try to run. If the runtime number is set too high, requests may wait longer than they need to before running. The number does not need to be exact but your throttling strategy depends heavily on this number being within reason. If averages range from 50 to 250 milliseconds you might pick an average run-time somewhere in the middle so that when GcpCompute performance is exceptional you might run a little slower than you might like, but when it is poor you still run efficiently. |
priorities | An array of priorities and how to handle them in relation to the throttle queue. Array of objects that include priority value and percent of queue to put the item ex { value: 1, percent: 10 } |
Proxy Properties
The proxy section defines the properties to utilize when GcpCompute is behind a proxy server.
Property | Description |
---|---|
enabled | Required. Default is false. If GcpCompute is behind a proxy server, set enabled flag to true. |
host | Host information for the proxy server. Required if `enabled` is true. |
port | Port information for the proxy server. Required if `enabled` is true. |
protocol | The protocol (i.e., http, https, etc.) used to connect to the proxy. Default is http. |
username | If there is authentication for the proxy, provide the username here. |
password | If there is authentication for the proxy, provide the password here. |
Mongo Properties
The mongo section defines the properties used to connect to a Mongo database. Mongo can be used for throttling as well as to persist metric data. If not provided, metrics will be stored in the file system.
Property | Description |
---|---|
host | Optional. Host information for the mongo server. |
port | Optional. Port information for the mongo server. |
database | Optional. The database for the adapter to use for its data. |
username | Optional. If credentials are required to access mongo, this is the user to login as. |
password | Optional. If credentials are required to access mongo, this is the password to login with. |
replSet | Optional. If the database is set up to use replica sets, define it here so it can be added to the database connection. |
db_ssl | Optional. Contains information for SSL connectivity to the database. |
db_ssl -> enabled | If SSL is required, set to true. |
db_ssl -> accept_invalid_cert | Defines if the adapter should accept invalid certificates (only recommended for lab environments). Required if SSL is enabled. Default is false. |
db_ssl -> ca_file | Defines the path name to the CA file used for SSL. If SSL is enabled and the accept invalid certifications is false, then ca_file is required. |
db_ssl -> key_file | Defines the path name to the Key file used for SSL. The key_file may be needed for some systems but it is not required for SSL. |
db_ssl -> cert_file | Defines the path name to the Certificate file used for SSL. The cert_file may be needed for some systems but it is not required for SSL. |
Device Broker Properties
The device broker section defines the properties used integrate GcpCompute to the device broker. Each broker call is represented and has an array of calls that can be used to build the response. This describes the calls and then the fields which are available in the calls.
Property | Description |
---|---|
getDevice | The array of calls used to get device details for the broker |
getDevicesFiltered | The array of calls used to get devices for the broker |
isAlive | The array of calls used to get device status for the broker |
getConfig | The array of calls used to get device configuration for the broker |
getCount | The array of calls used to get device configuration for the broker |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> path | The path, not including the base_path and version, for making this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> method | The rest method for making this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> query | Query object containing and query parameters and their values for this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> body | Body object containing the payload for this call |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> headers | Header object containing the headers for this call. |
getDevice/getDevicesFiltered/isAlive/getConfig/getCount -> handleFailure | Tells the adapter whether to "fail" or "ignore" failures if they occur. |
isAlive -> statusValue | Tells the adapter what value to look for in the status field to determine if the device is alive. |
getDevice/getDevicesFiltered/isAlive/getConfig -> requestFields | Object containing fields the adapter should send on the request and where it should get the data. The where can be from a response to a getDevicesFiltered or a static value. |
getDevice/getDevicesFiltered/isAlive/getConfig -> responseFields | Object containing fields the adapter should set to send back to iap and where the value should come from in the response or request data. |
Using this Adapter
The adapter.js
file contains the calls the adapter makes available to the rest of the Itential Platform. The API detailed for these calls should be available through JSDOC. The following is a brief summary of the calls.
Generic Adapter Calls
These are adapter methods that IAP or you might use. There are some other methods not shown here that might be used for internal adapter functionality.
Method Signature | Description | Workflow? |
---|---|---|
connect() | This call is run when the Adapter is first loaded by he Itential Platform. It validates the properties have been provided correctly. | No |
healthCheck(callback) | This call ensures that the adapter can communicate with Adapter for Google Cloud Platform Compute. The actual call that is used is defined in the adapter properties and .system entities action.json file. | No |
refreshProperties(properties) | This call provides the adapter the ability to accept property changes without having to restart the adapter. | No |
encryptProperty(property, technique, callback) | This call will take the provided property and technique, and return the property encrypted with the technique. This allows the property to be used in the adapterProps section for the credential password so that the password does not have to be in clear text. The adapter will decrypt the property as needed for communications with Adapter for Google Cloud Platform Compute. | No |
iapUpdateAdapterConfiguration(configFile, changes, entity, type, action, callback) | This call provides the ability to update the adapter configuration from IAP - includes actions, schema, mockdata and other configurations. | Yes |
iapSuspendAdapter(mode, callback) | This call provides the ability to suspend the adapter and either have requests rejected or put into a queue to be processed after the adapter is resumed. | Yes |
iapUnsuspendAdapter(callback) | This call provides the ability to resume a suspended adapter. Any requests in queue will be processed before new requests. | Yes |
iapGetAdapterQueue(callback) | This call will return the requests that are waiting in the queue if throttling is enabled. | Yes |
iapFindAdapterPath(apiPath, callback) | This call provides the ability to see if a particular API path is supported by the adapter. | Yes |
iapTroubleshootAdapter(props, persistFlag, adapter, callback) | This call can be used to check on the performance of the adapter - it checks connectivity, healthcheck and basic get calls. | Yes |
iapRunAdapterHealthcheck(adapter, callback) | This call will return the results of a healthcheck. | Yes |
iapRunAdapterConnectivity(callback) | This call will return the results of a connectivity check. | Yes |
iapRunAdapterBasicGet(callback) | This call will return the results of running basic get API calls. | Yes |
iapMoveAdapterEntitiesToDB(callback) | This call will push the adapter configuration from the entities directory into the Adapter or IAP Database. | Yes |
iapDeactivateTasks(tasks, callback) | This call provides the ability to remove tasks from the adapter. | Yes |
iapActivateTasks(tasks, callback) | This call provides the ability to add deactivated tasks back into the adapter. | Yes |
iapExpandedGenericAdapterRequest(metadata, uriPath, restMethod, pathVars, queryData, requestBody, addlHeaders, callback) | This is an expanded Generic Call. The metadata object allows us to provide many new capabilities within the generic request. | Yes |
genericAdapterRequest(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) | This call allows you to provide the path to have the adapter call. It is an easy way to incorporate paths that have not been built into the adapter yet. | Yes |
genericAdapterRequestNoBasePath(uriPath, restMethod, queryData, requestBody, addlHeaders, callback) | This call is the same as the genericAdapterRequest only it does not add a base_path or version to the call. | Yes |
iapRunAdapterLint(callback) | Runs lint on the addapter and provides the information back. | Yes |
iapRunAdapterTests(callback) | Runs baseunit and unit tests on the adapter and provides the information back. | Yes |
iapGetAdapterInventory(callback) | This call provides some inventory related information about the adapter. | Yes |
Adapter Cache Calls
These are adapter methods that are used for adapter caching. If configured, the adapter will cache based on the interval provided. However, you can force a population of the cache manually as well.
Method Signature | Description | Workflow? |
---|---|---|
iapPopulateEntityCache(entityTypes, callback) | This call populates the adapter cache. | Yes |
iapRetrieveEntitiesCache(entityType, options, callback) | This call retrieves the specific items from the adapter cache. | Yes |
Adapter Broker Calls
These are adapter methods that are used to integrate to IAP Brokers. This adapter currently supports the following broker calls.
Method Signature | Description | Workflow? |
---|---|---|
hasEntities(entityType, entityList, callback) | This call is utilized by the IAP Device Broker to determine if the adapter has a specific entity and item of the entity. | No |
getDevice(deviceName, callback) | This call returns the details of the requested device. | No |
getDevicesFiltered(options, callback) | This call returns the list of devices that match the criteria provided in the options filter. | No |
isAlive(deviceName, callback) | This call returns whether the device status is active | No |
getConfig(deviceName, format, callback) | This call returns the configuration for the selected device. | No |
iapGetDeviceCount(callback) | This call returns the count of devices. | No |
Specific Adapter Calls
Specific adapter calls are built based on the API of the GcpCompute. The Adapter Builder creates the proper method comments for generating JS-DOC for the adapter. This is the best way to get information on the calls.
Method Signature | Description | Path | Workflow? |
---|---|---|---|
getProject(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, callback) | Returns the specified Project resource. | {base_path}/{version}/projects/{pathv1}?{query} | Yes |
postProjectDisableXpnHost(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, callback) | Disable this project as a shared VPC host project. | {base_path}/{version}/projects/{pathv1}/disableXpnHost?{query} | Yes |
postProjectDisableXpnResource(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Disable a service resource (also known as service project) associated with this host project. | {base_path}/{version}/projects/{pathv1}/disableXpnResource?{query} | Yes |
postProjectEnableXpnHost(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, callback) | Enable this project as a shared VPC host project. | {base_path}/{version}/projects/{pathv1}/enableXpnHost?{query} | Yes |
postProjectEnableXpnResource(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/enableXpnResource?{query} | Yes |
getProjectGetXpnHost(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, callback) | Gets the shared VPC host project that this project links to. May be empty if no link exists. | {base_path}/{version}/projects/{pathv1}/getXpnHost?{query} | Yes |
getProjectGetXpnResources(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Gets service resources (a.k.a service project) associated with this host project. | {base_path}/{version}/projects/{pathv1}/getXpnResources?{query} | Yes |
postProjectListXpnHosts(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, body, callback) | Lists all shared VPC host projects visible to the user in an organization. | {base_path}/{version}/projects/{pathv1}/listXpnHosts?{query} | Yes |
postProjectMoveDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Moves a persistent disk from one zone to another. | {base_path}/{version}/projects/{pathv1}/moveDisk?{query} | Yes |
postProjectMoveInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Moves an instance and its attached persistent disks from one zone to another. | {base_path}/{version}/projects/{pathv1}/moveInstance?{query} | Yes |
postProjectSetCommonInstanceMetadata(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Sets metadata common to all instances within the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/setCommonInstanceMetadata?{query} | Yes |
postProjectSetDefaultNetworkTier(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/setDefaultNetworkTier?{query} | Yes |
postProjectSetUsageExportBucket(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/setUsageExportBucket?{query} | Yes |
getProjectAggregatedAcceleratorTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of accelerator types. | {base_path}/{version}/projects/{pathv1}/aggregated/acceleratorTypes?{query} | Yes |
getProjectZonesZoneAcceleratorTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of accelerator types that are available to the specified project. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/acceleratorTypes?{query} | Yes |
getProjectZonesZoneAcceleratorTypesAcceleratorType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, acceleratorType, callback) | Returns the specified accelerator type. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/acceleratorTypes/{pathv3}?{query} | Yes |
getProjectAggregatedAddresses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of addresses. | {base_path}/{version}/projects/{pathv1}/aggregated/addresses?{query} | Yes |
getProjectRegionsRegionAddresses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of addresses contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/addresses?{query} | Yes |
postProjectRegionsRegionAddresses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates an address resource in the specified project by using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/addresses?{query} | Yes |
deleteProjectRegionsRegionAddressesAddress(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, address, requestId, callback) | Deletes the specified address resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/addresses/{pathv3}?{query} | Yes |
getProjectRegionsRegionAddressesAddress(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, address, callback) | Returns the specified address resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/addresses/{pathv3}?{query} | Yes |
getProjectAggregatedAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of autoscalers. | {base_path}/{version}/projects/{pathv1}/aggregated/autoscalers?{query} | Yes |
getProjectZonesZoneAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of autoscalers contained within the specified zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers?{query} | Yes |
patchProjectZonesZoneAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, autoscaler, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers?{query} | Yes |
postProjectZonesZoneAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | Creates an autoscaler in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers?{query} | Yes |
putProjectZonesZoneAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, autoscaler, requestId, body, callback) | Updates an autoscaler in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers?{query} | Yes |
deleteProjectZonesZoneAutoscalersAutoscaler(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, autoscaler, requestId, callback) | Deletes the specified autoscaler. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers/{pathv3}?{query} | Yes |
getProjectZonesZoneAutoscalersAutoscaler(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, autoscaler, callback) | Returns the specified autoscaler resource. Gets a list of available autoscalers by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/autoscalers/{pathv3}?{query} | Yes |
getProjectAggregatedBackendServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all BackendService resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/backendServices?{query} | Yes |
getProjectGlobalBackendServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of BackendService resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/backendServices?{query} | Yes |
postProjectGlobalBackendServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. | {base_path}/{version}/projects/{pathv1}/global/backendServices?{query} | Yes |
deleteProjectGlobalBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, requestId, callback) | Deletes the specified BackendService resource. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}?{query} | Yes |
getProjectGlobalBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, callback) | Returns the specified BackendService resource. Gets a list of available backend services. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}?{query} | Yes |
patchProjectGlobalBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, requestId, body, callback) | Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}?{query} | Yes |
putProjectGlobalBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, requestId, body, callback) | Updates the specified BackendService resource with the data included in the request. For more information, see Backend services overview. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}?{query} | Yes |
postProjectGlobalBackendServicesBackendServiceAddSignedUrlKey(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, requestId, body, callback) | Adds a key for validating requests with signed URLs for this backend service. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}/addSignedUrlKey?{query} | Yes |
postProjectGlobalBackendServicesBackendServiceDeleteSignedUrlKey(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, keyName, requestId, callback) | Deletes a key for validating requests with signed URLs for this backend service. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}/deleteSignedUrlKey?{query} | Yes |
postProjectGlobalBackendServicesBackendServiceGetHealth(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, body, callback) | Gets the most recent health check results for this BackendService. Example request body: { "group": "/zones/us-east1-b/instanceGroups/lb-backend-example" } | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}/getHealth?{query} | Yes |
postProjectGlobalBackendServicesBackendServiceSetSecurityPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendService, requestId, body, callback) | Sets the security policy for the specified backend service. | {base_path}/{version}/projects/{pathv1}/global/backendServices/{pathv2}/setSecurityPolicy?{query} | Yes |
getProjectAggregatedCommitments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of commitments. | {base_path}/{version}/projects/{pathv1}/aggregated/commitments?{query} | Yes |
getProjectRegionsRegionCommitments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of commitments contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/commitments?{query} | Yes |
postProjectRegionsRegionCommitments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a commitment in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/commitments?{query} | Yes |
getProjectRegionsRegionCommitmentsCommitment(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, commitment, callback) | Returns the specified commitment resource. Gets a list of available commitments by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/commitments/{pathv3}?{query} | Yes |
getProjectAggregatedDiskTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of disk types. | {base_path}/{version}/projects/{pathv1}/aggregated/diskTypes?{query} | Yes |
getProjectZonesZoneDiskTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of disk types available to the specified project. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/diskTypes?{query} | Yes |
getProjectZonesZoneDiskTypesDiskType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, diskType, callback) | Returns the specified disk type. Gets a list of available disk types by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/diskTypes/{pathv3}?{query} | Yes |
getProjectAggregatedDisks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of persistent disks. | {base_path}/{version}/projects/{pathv1}/aggregated/disks?{query} | Yes |
getProjectZonesZoneDisks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of persistent disks contained within the specified zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks?{query} | Yes |
postProjectZonesZoneDisks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, sourceImage, body, callback) | Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks?{query} | Yes |
deleteProjectZonesZoneDisksDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, requestId, callback) | Deletes the specified persistent disk. Deleting a disk removes 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}?{query} | Yes |
getProjectZonesZoneDisksDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, callback) | Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}?{query} | Yes |
postProjectZonesZoneDisksDiskAddResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, requestId, body, callback) | Adds existing resource policies to a disk. You can only add one policy which will be applied to this disk for scheduling snapshot creation. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/addResourcePolicies?{query} | Yes |
postProjectZonesZoneDisksDiskCreateSnapshot(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, guestFlush, requestId, body, callback) | Creates a snapshot of a specified persistent disk. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/createSnapshot?{query} | Yes |
postProjectZonesZoneDisksDiskRemoveResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, requestId, body, callback) | Removes resource policies from a disk. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/removeResourcePolicies?{query} | Yes |
postProjectZonesZoneDisksDiskResize(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, disk, requestId, body, callback) | Resizes the specified persistent disk. You can only increase the size of the disk. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/resize?{query} | Yes |
getProjectZonesZoneDisksResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/getIamPolicy?{query} | Yes |
postProjectZonesZoneDisksResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/setIamPolicy?{query} | Yes |
postProjectZonesZoneDisksResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, requestId, body, callback) | Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/setLabels?{query} | Yes |
postProjectZonesZoneDisksResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/disks/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedForwardingRules(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of forwarding rules. | {base_path}/{version}/projects/{pathv1}/aggregated/forwardingRules?{query} | Yes |
getProjectRegionsRegionForwardingRules(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of ForwardingRule resources available to the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules?{query} | Yes |
postProjectRegionsRegionForwardingRules(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a ForwardingRule resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules?{query} | Yes |
deleteProjectRegionsRegionForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, forwardingRule, requestId, callback) | Deletes the specified ForwardingRule resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules/{pathv3}?{query} | Yes |
getProjectRegionsRegionForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, forwardingRule, callback) | Returns the specified ForwardingRule resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules/{pathv3}?{query} | Yes |
patchProjectRegionsRegionForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, forwardingRule, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules/{pathv3}?{query} | Yes |
postProjectRegionsRegionForwardingRulesForwardingRuleSetTarget(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, forwardingRule, requestId, body, callback) | Changes target URL for forwarding rule. The new target should be of the same type as the old target. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/forwardingRules/{pathv3}/setTarget?{query} | Yes |
getProjectAggregatedHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all HealthCheck resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/healthChecks?{query} | Yes |
getProjectGlobalHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of HealthCheck resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/healthChecks?{query} | Yes |
postProjectGlobalHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a HealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/healthChecks?{query} | Yes |
deleteProjectGlobalHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, healthCheck, requestId, callback) | Deletes the specified HealthCheck resource. | {base_path}/{version}/projects/{pathv1}/global/healthChecks/{pathv2}?{query} | Yes |
getProjectGlobalHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, healthCheck, callback) | Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/healthChecks/{pathv2}?{query} | Yes |
patchProjectGlobalHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, healthCheck, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/healthChecks/{pathv2}?{query} | Yes |
putProjectGlobalHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, healthCheck, requestId, body, callback) | Updates a HealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/healthChecks/{pathv2}?{query} | Yes |
getProjectAggregatedInstanceGroupManagers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of managed instance groups and groups them by zone. | {base_path}/{version}/projects/{pathv1}/aggregated/instanceGroupManagers?{query} | Yes |
getProjectZonesZoneInstanceGroupManagers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of managed instance groups that are contained within the specified project and zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers?{query} | Yes |
postProjectZonesZoneInstanceGroupManagers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | 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 ...(description truncated) | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers?{query} | Yes |
deleteProjectZonesZoneInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
getProjectZonesZoneInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, callback) | Returns all of the details about the specified managed instance group. Gets a list of available managed instance groups by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
patchProjectZonesZoneInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerAbandonInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | 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 s...(description truncated) | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/abandonInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerApplyUpdatesToInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, body, callback) | Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/applyUpdatesToInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerCreateInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | Creates instances with per-instance configs 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/createInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerDeleteInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | 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 ...(description truncated) | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/deleteInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerDeletePerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, body, callback) | Deletes selected per-instance configs for the managed instance group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/deletePerInstanceConfigs?{query} | Yes |
getProjectZonesZoneInstanceGroupManagersInstanceGroupManagerListErrors(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | Lists all errors thrown by actions on instances for a given managed instance group. The filter and orderBy query parameters are not supported. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/listErrors?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerListManagedInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/listManagedInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerListPerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/listPerInstanceConfigs?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerPatchPerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | Inserts or patches per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/patchPerInstanceConfigs?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerRecreateInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. 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 the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up t...(description truncated) | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/recreateInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerResize(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, size, requestId, callback) | 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 or...(description truncated) | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/resize?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerSetInstanceTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | 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 recreate them. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/setInstanceTemplate?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerSetTargetPools(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/setTargetPools?{query} | Yes |
postProjectZonesZoneInstanceGroupManagersInstanceGroupManagerUpdatePerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroupManager, requestId, body, callback) | Inserts or updates per-instance configs for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroupManagers/{pathv3}/updatePerInstanceConfigs?{query} | Yes |
getProjectAggregatedInstanceGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of instance groups and sorts them by zone. | {base_path}/{version}/projects/{pathv1}/aggregated/instanceGroups?{query} | Yes |
getProjectZonesZoneInstanceGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of instance groups that are located in the specified project and zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups?{query} | Yes |
postProjectZonesZoneInstanceGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | Creates an instance group in the specified project using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups?{query} | Yes |
deleteProjectZonesZoneInstanceGroupsInstanceGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}?{query} | Yes |
getProjectZonesZoneInstanceGroupsInstanceGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, callback) | Returns the specified instance group. Gets a list of available instance groups by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}?{query} | Yes |
postProjectZonesZoneInstanceGroupsInstanceGroupAddInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}/addInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupsInstanceGroupListInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, filter, maxResults, orderBy, pageToken, body, callback) | Lists the instances in the specified instance group. The orderBy query parameter is not supported. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}/listInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupsInstanceGroupRemoveInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}/removeInstances?{query} | Yes |
postProjectZonesZoneInstanceGroupsInstanceGroupSetNamedPorts(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instanceGroup, requestId, body, callback) | Sets the named ports for the specified instance group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instanceGroups/{pathv3}/setNamedPorts?{query} | Yes |
getProjectAggregatedInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves aggregated list of all of the instances in your project across all regions and zones. | {base_path}/{version}/projects/{pathv1}/aggregated/instances?{query} | Yes |
getProjectZonesZoneInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of instances contained within the specified zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances?{query} | Yes |
postProjectZonesZoneInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, sourceInstanceTemplate, body, callback) | Creates an instance resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances?{query} | Yes |
deleteProjectZonesZoneInstancesInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, callback) | Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}?{query} | Yes |
getProjectZonesZoneInstancesInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, callback) | Returns the specified Instance resource. Gets a list of available instances by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}?{query} | Yes |
putProjectZonesZoneInstancesInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, minimalAction = 'INVALID', mostDisruptiveAllowedAction = 'INVALID', requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}?{query} | Yes |
postProjectZonesZoneInstancesInstanceAddAccessConfig(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, networkInterface, requestId, body, callback) | Adds an access config to an instance's network interface. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/addAccessConfig?{query} | Yes |
postProjectZonesZoneInstancesInstanceAddResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/addResourcePolicies?{query} | Yes |
postProjectZonesZoneInstancesInstanceAttachDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, forceAttach, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/attachDisk?{query} | Yes |
postProjectZonesZoneInstancesInstanceDeleteAccessConfig(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, accessConfig, networkInterface, requestId, callback) | Deletes an access config from an instance's network interface. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/deleteAccessConfig?{query} | Yes |
postProjectZonesZoneInstancesInstanceDetachDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, deviceName, requestId, callback) | Detaches a disk from an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/detachDisk?{query} | Yes |
getProjectZonesZoneInstancesInstanceGetGuestAttributes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, queryPath, variableKey, callback) | Returns the specified guest attributes entry. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/getGuestAttributes?{query} | Yes |
getProjectZonesZoneInstancesInstanceGetShieldedInstanceIdentity(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, callback) | Returns the Shielded Instance Identity of an instance | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/getShieldedInstanceIdentity?{query} | Yes |
getProjectZonesZoneInstancesInstanceReferrers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, filter, maxResults, orderBy, pageToken, callback) | 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 instance group, the referrers list includes the managed instance group. For more information, read Viewing Referrers to VM Instances. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/referrers?{query} | Yes |
postProjectZonesZoneInstancesInstanceRemoveResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Removes resource policies from an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/removeResourcePolicies?{query} | Yes |
postProjectZonesZoneInstancesInstanceReset(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/reset?{query} | Yes |
getProjectZonesZoneInstancesInstanceScreenshot(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, callback) | Returns the screenshot from the specified instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/screenshot?{query} | Yes |
getProjectZonesZoneInstancesInstanceSerialPort(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, port, start, callback) | Returns the last 1 MB of serial port output from the specified instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/serialPort?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetDiskAutoDelete(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, autoDelete, deviceName, requestId, callback) | Sets the auto-delete flag for a disk attached to an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setDiskAutoDelete?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setLabels?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetMachineResources(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Changes the number and/or type of accelerator for a stopped instance to the values specified in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setMachineResources?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetMachineType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Changes the machine type for a stopped instance to the machine type specified in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setMachineType?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetMetadata(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Sets metadata for the specified instance to the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setMetadata?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetMinCpuPlatform(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setMinCpuPlatform?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetScheduling(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setScheduling?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetServiceAccount(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Sets the service account on the instance. For more information, read Changing the service account and access scopes for an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setServiceAccount?{query} | Yes |
patchProjectZonesZoneInstancesInstanceSetShieldedInstanceIntegrityPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setShieldedInstanceIntegrityPolicy?{query} | Yes |
postProjectZonesZoneInstancesInstanceSetTags(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Sets network tags for the specified instance to the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setTags?{query} | Yes |
postProjectZonesZoneInstancesInstanceSimulateMaintenanceEvent(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, callback) | Simulates a maintenance event on the instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/simulateMaintenanceEvent?{query} | Yes |
postProjectZonesZoneInstancesInstanceStart(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, callback) | Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/start?{query} | Yes |
postProjectZonesZoneInstancesInstanceStartWithEncryptionKey(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/startWithEncryptionKey?{query} | Yes |
postProjectZonesZoneInstancesInstanceStop(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/stop?{query} | Yes |
postProjectZonesZoneInstancesInstanceUpdateAccessConfig(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, networkInterface, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/updateAccessConfig?{query} | Yes |
patchProjectZonesZoneInstancesInstanceUpdateDisplayDevice(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/updateDisplayDevice?{query} | Yes |
patchProjectZonesZoneInstancesInstanceUpdateNetworkInterface(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, networkInterface, requestId, body, callback) | Updates an instance's network interface. This method follows PATCH semantics. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/updateNetworkInterface?{query} | Yes |
patchProjectZonesZoneInstancesInstanceUpdateShieldedInstanceConfig(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, instance, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/updateShieldedInstanceConfig?{query} | Yes |
getProjectZonesZoneInstancesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/getIamPolicy?{query} | Yes |
postProjectZonesZoneInstancesResourceSetDeletionProtection(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, deletionProtection, requestId, callback) | Sets deletion protection on the instance. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setDeletionProtection?{query} | Yes |
postProjectZonesZoneInstancesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/setIamPolicy?{query} | Yes |
postProjectZonesZoneInstancesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/instances/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedInterconnectAttachments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of interconnect attachments. | {base_path}/{version}/projects/{pathv1}/aggregated/interconnectAttachments?{query} | Yes |
getProjectRegionsRegionInterconnectAttachments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of interconnect attachments contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/interconnectAttachments?{query} | Yes |
postProjectRegionsRegionInterconnectAttachments(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, validateOnly, body, callback) | Creates an InterconnectAttachment in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/interconnectAttachments?{query} | Yes |
deleteProjectRegionsRegionInterconnectAttachmentsInterconnectAttachment(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, interconnectAttachment, requestId, callback) | Deletes the specified interconnect attachment. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/interconnectAttachments/{pathv3}?{query} | Yes |
getProjectRegionsRegionInterconnectAttachmentsInterconnectAttachment(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, interconnectAttachment, callback) | Returns the specified interconnect attachment. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/interconnectAttachments/{pathv3}?{query} | Yes |
patchProjectRegionsRegionInterconnectAttachmentsInterconnectAttachment(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, interconnectAttachment, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/interconnectAttachments/{pathv3}?{query} | Yes |
getProjectAggregatedMachineTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of machine types. | {base_path}/{version}/projects/{pathv1}/aggregated/machineTypes?{query} | Yes |
getProjectZonesZoneMachineTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of machine types available to the specified project. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/machineTypes?{query} | Yes |
getProjectZonesZoneMachineTypesMachineType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, machineType, callback) | Returns the specified machine type. Gets a list of available machine types by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/machineTypes/{pathv3}?{query} | Yes |
getProjectAggregatedNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of network endpoint groups and sorts them by zone. | {base_path}/{version}/projects/{pathv1}/aggregated/networkEndpointGroups?{query} | Yes |
getProjectZonesZoneNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of network endpoint groups that are located in the specified project and zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups?{query} | Yes |
postProjectZonesZoneNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | Creates a network endpoint group in the specified project using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups?{query} | Yes |
deleteProjectZonesZoneNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, networkEndpointGroup, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}?{query} | Yes |
getProjectZonesZoneNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, networkEndpointGroup, callback) | Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}?{query} | Yes |
postProjectZonesZoneNetworkEndpointGroupsNetworkEndpointGroupAttachNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, networkEndpointGroup, requestId, body, callback) | Attach a list of network endpoints to the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}/attachNetworkEndpoints?{query} | Yes |
postProjectZonesZoneNetworkEndpointGroupsNetworkEndpointGroupDetachNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, networkEndpointGroup, requestId, body, callback) | Detach a list of network endpoints from the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}/detachNetworkEndpoints?{query} | Yes |
postProjectZonesZoneNetworkEndpointGroupsNetworkEndpointGroupListNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, networkEndpointGroup, filter, maxResults, orderBy, pageToken, body, callback) | Lists the network endpoints in the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}/listNetworkEndpoints?{query} | Yes |
postProjectZonesZoneNetworkEndpointGroupsResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/networkEndpointGroups/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedNodeGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. | {base_path}/{version}/projects/{pathv1}/aggregated/nodeGroups?{query} | Yes |
getProjectZonesZoneNodeGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups?{query} | Yes |
postProjectZonesZoneNodeGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, initialNodeCount, requestId, body, callback) | Creates a NodeGroup resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups?{query} | Yes |
deleteProjectZonesZoneNodeGroupsNodeGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, requestId, callback) | Deletes the specified NodeGroup resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}?{query} | Yes |
getProjectZonesZoneNodeGroupsNodeGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, callback) | 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. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}?{query} | Yes |
patchProjectZonesZoneNodeGroupsNodeGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, requestId, body, callback) | Updates the specified node group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}?{query} | Yes |
postProjectZonesZoneNodeGroupsNodeGroupAddNodes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, requestId, body, callback) | Adds specified number of nodes to the node group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/addNodes?{query} | Yes |
postProjectZonesZoneNodeGroupsNodeGroupDeleteNodes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, requestId, body, callback) | Deletes specified nodes from the node group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/deleteNodes?{query} | Yes |
postProjectZonesZoneNodeGroupsNodeGroupListNodes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, filter, maxResults, orderBy, pageToken, callback) | Lists nodes in the node group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/listNodes?{query} | Yes |
postProjectZonesZoneNodeGroupsNodeGroupSetNodeTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeGroup, requestId, body, callback) | Updates the node template of the node group. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/setNodeTemplate?{query} | Yes |
getProjectZonesZoneNodeGroupsResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/getIamPolicy?{query} | Yes |
postProjectZonesZoneNodeGroupsResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/setIamPolicy?{query} | Yes |
postProjectZonesZoneNodeGroupsResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeGroups/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedNodeTemplates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of node templates. | {base_path}/{version}/projects/{pathv1}/aggregated/nodeTemplates?{query} | Yes |
getProjectRegionsRegionNodeTemplates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of node templates available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates?{query} | Yes |
postProjectRegionsRegionNodeTemplates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a NodeTemplate resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates?{query} | Yes |
deleteProjectRegionsRegionNodeTemplatesNodeTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, nodeTemplate, requestId, callback) | Deletes the specified NodeTemplate resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates/{pathv3}?{query} | Yes |
getProjectRegionsRegionNodeTemplatesNodeTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, nodeTemplate, callback) | Returns the specified node template. Gets a list of available node templates by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates/{pathv3}?{query} | Yes |
getProjectRegionsRegionNodeTemplatesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates/{pathv3}/getIamPolicy?{query} | Yes |
postProjectRegionsRegionNodeTemplatesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates/{pathv3}/setIamPolicy?{query} | Yes |
postProjectRegionsRegionNodeTemplatesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/nodeTemplates/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedNodeTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of node types. | {base_path}/{version}/projects/{pathv1}/aggregated/nodeTypes?{query} | Yes |
getProjectZonesZoneNodeTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of node types available to the specified project. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeTypes?{query} | Yes |
getProjectZonesZoneNodeTypesNodeType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, nodeType, callback) | Returns the specified node type. Gets a list of available node types by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/nodeTypes/{pathv3}?{query} | Yes |
getProjectAggregatedOperations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of all operations. | {base_path}/{version}/projects/{pathv1}/aggregated/operations?{query} | Yes |
getProjectGlobalOperations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of Operation resources contained within the specified project. | {base_path}/{version}/projects/{pathv1}/global/operations?{query} | Yes |
deleteProjectGlobalOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, operation, callback) | Deletes the specified Operations resource. | {base_path}/{version}/projects/{pathv1}/global/operations/{pathv2}?{query} | Yes |
getProjectGlobalOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, operation, callback) | Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request. | {base_path}/{version}/projects/{pathv1}/global/operations/{pathv2}?{query} | Yes |
postProjectGlobalOperationsOperationWait(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, operation, callback) | 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:
| {base_path}/{version}/projects/{pathv1}/global/operations/{pathv2}/wait?{query} | Yes |
getProjectAggregatedPacketMirrorings(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of packetMirrorings. | {base_path}/{version}/projects/{pathv1}/aggregated/packetMirrorings?{query} | Yes |
getProjectRegionsRegionPacketMirrorings(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of PacketMirroring resources available to the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings?{query} | Yes |
postProjectRegionsRegionPacketMirrorings(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a PacketMirroring resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings?{query} | Yes |
deleteProjectRegionsRegionPacketMirroringsPacketMirroring(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, packetMirroring, requestId, callback) | Deletes the specified PacketMirroring resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings/{pathv3}?{query} | Yes |
getProjectRegionsRegionPacketMirroringsPacketMirroring(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, packetMirroring, callback) | Returns the specified PacketMirroring resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings/{pathv3}?{query} | Yes |
patchProjectRegionsRegionPacketMirroringsPacketMirroring(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, packetMirroring, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings/{pathv3}?{query} | Yes |
postProjectRegionsRegionPacketMirroringsResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/packetMirrorings/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedReservations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of reservations. | {base_path}/{version}/projects/{pathv1}/aggregated/reservations?{query} | Yes |
getProjectZonesZoneReservations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | A list of all the reservations that have been configured for the specified project in specified zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations?{query} | Yes |
postProjectZonesZoneReservations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | Creates a new reservation. For more information, read Reserving zonal resources. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations?{query} | Yes |
deleteProjectZonesZoneReservationsReservation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, reservation, requestId, callback) | Deletes the specified reservation. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}?{query} | Yes |
getProjectZonesZoneReservationsReservation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, reservation, callback) | Retrieves information about the specified reservation. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}?{query} | Yes |
postProjectZonesZoneReservationsReservationResize(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, reservation, requestId, body, callback) | Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}/resize?{query} | Yes |
getProjectZonesZoneReservationsResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}/getIamPolicy?{query} | Yes |
postProjectZonesZoneReservationsResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}/setIamPolicy?{query} | Yes |
postProjectZonesZoneReservationsResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/reservations/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of resource policies. | {base_path}/{version}/projects/{pathv1}/aggregated/resourcePolicies?{query} | Yes |
getProjectRegionsRegionResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | A list all the resource policies that have been configured for the specified project in specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies?{query} | Yes |
postProjectRegionsRegionResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a new resource policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies?{query} | Yes |
deleteProjectRegionsRegionResourcePoliciesResourcePolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resourcePolicy, requestId, callback) | Deletes the specified resource policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies/{pathv3}?{query} | Yes |
getProjectRegionsRegionResourcePoliciesResourcePolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resourcePolicy, callback) | Retrieves all information of the specified resource policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies/{pathv3}?{query} | Yes |
getProjectRegionsRegionResourcePoliciesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies/{pathv3}/getIamPolicy?{query} | Yes |
postProjectRegionsRegionResourcePoliciesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies/{pathv3}/setIamPolicy?{query} | Yes |
postProjectRegionsRegionResourcePoliciesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/resourcePolicies/{pathv3}/testIamPermissions?{query} | Yes |
getProjectAggregatedRouters(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of routers. | {base_path}/{version}/projects/{pathv1}/aggregated/routers?{query} | Yes |
getProjectRegionsRegionRouters(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of Router resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers?{query} | Yes |
postProjectRegionsRegionRouters(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a Router resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers?{query} | Yes |
deleteProjectRegionsRegionRoutersRouter(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, requestId, callback) | Deletes the specified Router resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}?{query} | Yes |
getProjectRegionsRegionRoutersRouter(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, callback) | Returns the specified Router resource. Gets a list of available routers by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}?{query} | Yes |
patchProjectRegionsRegionRoutersRouter(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}?{query} | Yes |
putProjectRegionsRegionRoutersRouter(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, requestId, body, callback) | Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}?{query} | Yes |
getProjectRegionsRegionRoutersRouterGetNatMappingInfo(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, filter, maxResults, orderBy, pageToken, callback) | Retrieves runtime Nat mapping information of VM endpoints. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}/getNatMappingInfo?{query} | Yes |
getProjectRegionsRegionRoutersRouterGetRouterStatus(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, callback) | Retrieves runtime information of the specified router. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}/getRouterStatus?{query} | Yes |
postProjectRegionsRegionRoutersRouterPreview(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, router, body, callback) | Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/routers/{pathv3}/preview?{query} | Yes |
getProjectAggregatedSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all SslCertificate resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/sslCertificates?{query} | Yes |
getProjectGlobalSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of SslCertificate resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/sslCertificates?{query} | Yes |
postProjectGlobalSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a SslCertificate resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/sslCertificates?{query} | Yes |
deleteProjectGlobalSslCertificatesSslCertificate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, sslCertificate, requestId, callback) | Deletes the specified SslCertificate resource. | {base_path}/{version}/projects/{pathv1}/global/sslCertificates/{pathv2}?{query} | Yes |
getProjectGlobalSslCertificatesSslCertificate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, sslCertificate, callback) | Returns the specified SslCertificate resource. Gets a list of available SSL certificates by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/sslCertificates/{pathv2}?{query} | Yes |
getProjectAggregatedSubnetworks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of subnetworks. | {base_path}/{version}/projects/{pathv1}/aggregated/subnetworks?{query} | Yes |
getProjectAggregatedSubnetworksListUsable(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of all usable subnetworks in the project. | {base_path}/{version}/projects/{pathv1}/aggregated/subnetworks/listUsable?{query} | Yes |
getProjectRegionsRegionSubnetworks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of subnetworks available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks?{query} | Yes |
postProjectRegionsRegionSubnetworks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a subnetwork in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks?{query} | Yes |
getProjectRegionsRegionSubnetworksResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}/getIamPolicy?{query} | Yes |
postProjectRegionsRegionSubnetworksResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}/setIamPolicy?{query} | Yes |
postProjectRegionsRegionSubnetworksResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}/testIamPermissions?{query} | Yes |
deleteProjectRegionsRegionSubnetworksSubnetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, subnetwork, requestId, callback) | Deletes the specified subnetwork. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}?{query} | Yes |
getProjectRegionsRegionSubnetworksSubnetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, subnetwork, callback) | Returns the specified subnetwork. Gets a list of available subnetworks list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}?{query} | Yes |
patchProjectRegionsRegionSubnetworksSubnetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, subnetwork, drainTimeoutSeconds, requestId, body, callback) | Patches the specified subnetwork with the data included in the request. Only certain fields can up updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}?{query} | Yes |
postProjectRegionsRegionSubnetworksSubnetworkExpandIpCidrRange(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, subnetwork, requestId, body, callback) | Expands the IP CIDR range of the subnetwork to a specified value. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}/expandIpCidrRange?{query} | Yes |
postProjectRegionsRegionSubnetworksSubnetworkSetPrivateIpGoogleAccess(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, subnetwork, requestId, body, callback) | Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/subnetworks/{pathv3}/setPrivateIpGoogleAccess?{query} | Yes |
getProjectAggregatedTargetHttpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/targetHttpProxies?{query} | Yes |
getProjectGlobalTargetHttpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetHttpProxy resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/targetHttpProxies?{query} | Yes |
postProjectGlobalTargetHttpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a TargetHttpProxy resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/targetHttpProxies?{query} | Yes |
deleteProjectGlobalTargetHttpProxiesTargetHttpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpProxy, requestId, callback) | Deletes the specified TargetHttpProxy resource. | {base_path}/{version}/projects/{pathv1}/global/targetHttpProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetHttpProxiesTargetHttpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpProxy, callback) | Returns the specified TargetHttpProxy resource. Gets a list of available target HTTP proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/targetHttpProxies/{pathv2}?{query} | Yes |
postProjectTargetHttpProxiesTargetHttpProxySetUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpProxy, requestId, body, callback) | Changes the URL map for TargetHttpProxy. | {base_path}/{version}/projects/{pathv1}/targetHttpProxies/{pathv2}/setUrlMap?{query} | Yes |
getProjectAggregatedTargetHttpsProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all TargetHttpsProxy resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/targetHttpsProxies?{query} | Yes |
getProjectGlobalTargetHttpsProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetHttpsProxy resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies?{query} | Yes |
postProjectGlobalTargetHttpsProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a TargetHttpsProxy resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies?{query} | Yes |
deleteProjectGlobalTargetHttpsProxiesTargetHttpsProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, requestId, callback) | Deletes the specified TargetHttpsProxy resource. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetHttpsProxiesTargetHttpsProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, callback) | Returns the specified TargetHttpsProxy resource. Gets a list of available target HTTPS proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies/{pathv2}?{query} | Yes |
postProjectGlobalTargetHttpsProxiesTargetHttpsProxySetQuicOverride(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, requestId, body, callback) | Sets the QUIC override policy for TargetHttpsProxy. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies/{pathv2}/setQuicOverride?{query} | Yes |
postProjectGlobalTargetHttpsProxiesTargetHttpsProxySetSslPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, requestId, body, callback) | Sets the SSL policy for TargetHttpsProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the HTTPS proxy load balancer. They do not affect the connection between the load balancer and the backends. | {base_path}/{version}/projects/{pathv1}/global/targetHttpsProxies/{pathv2}/setSslPolicy?{query} | Yes |
postProjectTargetHttpsProxiesTargetHttpsProxySetSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, requestId, body, callback) | Replaces SslCertificates for TargetHttpsProxy. | {base_path}/{version}/projects/{pathv1}/targetHttpsProxies/{pathv2}/setSslCertificates?{query} | Yes |
postProjectTargetHttpsProxiesTargetHttpsProxySetUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetHttpsProxy, requestId, body, callback) | Changes the URL map for TargetHttpsProxy. | {base_path}/{version}/projects/{pathv1}/targetHttpsProxies/{pathv2}/setUrlMap?{query} | Yes |
getProjectAggregatedTargetInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of target instances. | {base_path}/{version}/projects/{pathv1}/aggregated/targetInstances?{query} | Yes |
getProjectZonesZoneTargetInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of TargetInstance resources available to the specified project and zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/targetInstances?{query} | Yes |
postProjectZonesZoneTargetInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, requestId, body, callback) | Creates a TargetInstance resource in the specified project and zone using the data included in the request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/targetInstances?{query} | Yes |
deleteProjectZonesZoneTargetInstancesTargetInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, targetInstance, requestId, callback) | Deletes the specified TargetInstance resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/targetInstances/{pathv3}?{query} | Yes |
getProjectZonesZoneTargetInstancesTargetInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, targetInstance, callback) | Returns the specified TargetInstance resource. Gets a list of available target instances by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/targetInstances/{pathv3}?{query} | Yes |
getProjectAggregatedTargetPools(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of target pools. | {base_path}/{version}/projects/{pathv1}/aggregated/targetPools?{query} | Yes |
getProjectRegionsRegionTargetPools(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of target pools available to the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools?{query} | Yes |
postProjectRegionsRegionTargetPools(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a target pool in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools?{query} | Yes |
deleteProjectRegionsRegionTargetPoolsTargetPool(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, requestId, callback) | Deletes the specified target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}?{query} | Yes |
getProjectRegionsRegionTargetPoolsTargetPool(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, callback) | Returns the specified target pool. Gets a list of available target pools by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolAddHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, requestId, body, callback) | Adds health check URLs to a target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/addHealthCheck?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolAddInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, requestId, body, callback) | Adds an instance to a target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/addInstance?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolGetHealth(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, body, callback) | Gets the most recent health check results for each IP for the instance that is referenced by the given target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/getHealth?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolRemoveHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, requestId, body, callback) | Removes health check URL from a target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/removeHealthCheck?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolRemoveInstance(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, requestId, body, callback) | Removes instance URL from a target pool. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/removeInstance?{query} | Yes |
postProjectRegionsRegionTargetPoolsTargetPoolSetBackup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetPool, failoverRatio, requestId, body, callback) | Changes a backup target pool's configurations. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetPools/{pathv3}/setBackup?{query} | Yes |
getProjectAggregatedTargetVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of target VPN gateways. | {base_path}/{version}/projects/{pathv1}/aggregated/targetVpnGateways?{query} | Yes |
getProjectRegionsRegionTargetVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of target VPN gateways available to the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetVpnGateways?{query} | Yes |
postProjectRegionsRegionTargetVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a target VPN gateway in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetVpnGateways?{query} | Yes |
deleteProjectRegionsRegionTargetVpnGatewaysTargetVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetVpnGateway, requestId, callback) | Deletes the specified target VPN gateway. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetVpnGateways/{pathv3}?{query} | Yes |
getProjectRegionsRegionTargetVpnGatewaysTargetVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetVpnGateway, callback) | Returns the specified target VPN gateway. Gets a list of available target VPN gateways by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetVpnGateways/{pathv3}?{query} | Yes |
getProjectAggregatedUrlMaps(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves the list of all UrlMap resources, regional and global, available to the specified project. | {base_path}/{version}/projects/{pathv1}/aggregated/urlMaps?{query} | Yes |
getProjectGlobalUrlMaps(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of UrlMap resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/urlMaps?{query} | Yes |
postProjectGlobalUrlMaps(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a UrlMap resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/urlMaps?{query} | Yes |
deleteProjectGlobalUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, requestId, callback) | Deletes the specified UrlMap resource. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}?{query} | Yes |
getProjectGlobalUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, callback) | Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}?{query} | Yes |
patchProjectGlobalUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, requestId, body, callback) | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}?{query} | Yes |
putProjectGlobalUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, requestId, body, callback) | Updates the specified UrlMap resource with the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}?{query} | Yes |
postProjectGlobalUrlMapsUrlMapInvalidateCache(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, requestId, body, callback) | Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}/invalidateCache?{query} | Yes |
postProjectGlobalUrlMapsUrlMapValidate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, urlMap, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/urlMaps/{pathv2}/validate?{query} | Yes |
getProjectAggregatedVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of VPN gateways. | {base_path}/{version}/projects/{pathv1}/aggregated/vpnGateways?{query} | Yes |
getProjectRegionsRegionVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of VPN gateways available to the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways?{query} | Yes |
postProjectRegionsRegionVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a VPN gateway in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways?{query} | Yes |
postProjectRegionsRegionVpnGatewaysResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, requestId, body, callback) | Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways/{pathv3}/setLabels?{query} | Yes |
postProjectRegionsRegionVpnGatewaysResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways/{pathv3}/testIamPermissions?{query} | Yes |
deleteProjectRegionsRegionVpnGatewaysVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, vpnGateway, requestId, callback) | Deletes the specified VPN gateway. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways/{pathv3}?{query} | Yes |
getProjectRegionsRegionVpnGatewaysVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, vpnGateway, callback) | Returns the specified VPN gateway. Gets a list of available VPN gateways by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways/{pathv3}?{query} | Yes |
getProjectRegionsRegionVpnGatewaysVpnGatewayGetStatus(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, vpnGateway, callback) | Returns the status for the specified VPN gateway. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnGateways/{pathv3}/getStatus?{query} | Yes |
getProjectAggregatedVpnTunnels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, includeAllScopes, maxResults, orderBy, pageToken, callback) | Retrieves an aggregated list of VPN tunnels. | {base_path}/{version}/projects/{pathv1}/aggregated/vpnTunnels?{query} | Yes |
getProjectRegionsRegionVpnTunnels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of VpnTunnel resources contained in the specified project and region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnTunnels?{query} | Yes |
postProjectRegionsRegionVpnTunnels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a VpnTunnel resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnTunnels?{query} | Yes |
deleteProjectRegionsRegionVpnTunnelsVpnTunnel(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, vpnTunnel, requestId, callback) | Deletes the specified VpnTunnel resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnTunnels/{pathv3}?{query} | Yes |
getProjectRegionsRegionVpnTunnelsVpnTunnel(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, vpnTunnel, callback) | Returns the specified VpnTunnel resource. Gets a list of available VPN tunnels by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/vpnTunnels/{pathv3}?{query} | Yes |
getProjectGlobalAddresses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of global addresses. | {base_path}/{version}/projects/{pathv1}/global/addresses?{query} | Yes |
postProjectGlobalAddresses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates an address resource in the specified project by using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/addresses?{query} | Yes |
deleteProjectGlobalAddressesAddress(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, address, requestId, callback) | Deletes the specified address resource. | {base_path}/{version}/projects/{pathv1}/global/addresses/{pathv2}?{query} | Yes |
getProjectGlobalAddressesAddress(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, address, callback) | Returns the specified address resource. Gets a list of available addresses by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/addresses/{pathv2}?{query} | Yes |
getProjectGlobalBackendBuckets(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of BackendBucket resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets?{query} | Yes |
postProjectGlobalBackendBuckets(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a BackendBucket resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets?{query} | Yes |
deleteProjectGlobalBackendBucketsBackendBucket(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, requestId, callback) | Deletes the specified BackendBucket resource. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}?{query} | Yes |
getProjectGlobalBackendBucketsBackendBucket(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, callback) | Returns the specified BackendBucket resource. Gets a list of available backend buckets by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}?{query} | Yes |
patchProjectGlobalBackendBucketsBackendBucket(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}?{query} | Yes |
putProjectGlobalBackendBucketsBackendBucket(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, requestId, body, callback) | Updates the specified BackendBucket resource with the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}?{query} | Yes |
postProjectGlobalBackendBucketsBackendBucketAddSignedUrlKey(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, requestId, body, callback) | Adds a key for validating requests with signed URLs for this backend bucket. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}/addSignedUrlKey?{query} | Yes |
postProjectGlobalBackendBucketsBackendBucketDeleteSignedUrlKey(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, backendBucket, keyName, requestId, callback) | Deletes a key for validating requests with signed URLs for this backend bucket. | {base_path}/{version}/projects/{pathv1}/global/backendBuckets/{pathv2}/deleteSignedUrlKey?{query} | Yes |
getProjectGlobalExternalVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of ExternalVpnGateway available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways?{query} | Yes |
postProjectGlobalExternalVpnGateways(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a ExternalVpnGateway in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways?{query} | Yes |
deleteProjectGlobalExternalVpnGatewaysExternalVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, externalVpnGateway, requestId, callback) | Deletes the specified externalVpnGateway. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways/{pathv2}?{query} | Yes |
getProjectGlobalExternalVpnGatewaysExternalVpnGateway(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, externalVpnGateway, callback) | Returns the specified externalVpnGateway. Get a list of available externalVpnGateways by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways/{pathv2}?{query} | Yes |
postProjectGlobalExternalVpnGatewaysResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways/{pathv2}/setLabels?{query} | Yes |
postProjectGlobalExternalVpnGatewaysResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/global/externalVpnGateways/{pathv2}/testIamPermissions?{query} | Yes |
getProjectGlobalFirewalls(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of firewall rules available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/firewalls?{query} | Yes |
postProjectGlobalFirewalls(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a firewall rule in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/firewalls?{query} | Yes |
deleteProjectGlobalFirewallsFirewall(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, firewall, requestId, callback) | Deletes the specified firewall. | {base_path}/{version}/projects/{pathv1}/global/firewalls/{pathv2}?{query} | Yes |
getProjectGlobalFirewallsFirewall(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, firewall, callback) | Returns the specified firewall. | {base_path}/{version}/projects/{pathv1}/global/firewalls/{pathv2}?{query} | Yes |
patchProjectGlobalFirewallsFirewall(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, firewall, requestId, body, callback) | Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | {base_path}/{version}/projects/{pathv1}/global/firewalls/{pathv2}?{query} | Yes |
putProjectGlobalFirewallsFirewall(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, firewall, requestId, body, callback) | Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. | {base_path}/{version}/projects/{pathv1}/global/firewalls/{pathv2}?{query} | Yes |
getProjectGlobalForwardingRules(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of GlobalForwardingRule resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules?{query} | Yes |
postProjectGlobalForwardingRules(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a GlobalForwardingRule resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules?{query} | Yes |
deleteProjectGlobalForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, forwardingRule, requestId, callback) | Deletes the specified GlobalForwardingRule resource. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules/{pathv2}?{query} | Yes |
getProjectGlobalForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, forwardingRule, callback) | Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules/{pathv2}?{query} | Yes |
patchProjectGlobalForwardingRulesForwardingRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, forwardingRule, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules/{pathv2}?{query} | Yes |
postProjectGlobalForwardingRulesForwardingRuleSetTarget(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, forwardingRule, requestId, body, callback) | Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. | {base_path}/{version}/projects/{pathv1}/global/forwardingRules/{pathv2}/setTarget?{query} | Yes |
getProjectGlobalHttpHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of HttpHealthCheck resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks?{query} | Yes |
postProjectGlobalHttpHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a HttpHealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks?{query} | Yes |
deleteProjectGlobalHttpHealthChecksHttpHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpHealthCheck, requestId, callback) | Deletes the specified HttpHealthCheck resource. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks/{pathv2}?{query} | Yes |
getProjectGlobalHttpHealthChecksHttpHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpHealthCheck, callback) | Returns the specified HttpHealthCheck resource. Gets a list of available HTTP health checks by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks/{pathv2}?{query} | Yes |
patchProjectGlobalHttpHealthChecksHttpHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpHealthCheck, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks/{pathv2}?{query} | Yes |
putProjectGlobalHttpHealthChecksHttpHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpHealthCheck, requestId, body, callback) | Updates a HttpHealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/httpHealthChecks/{pathv2}?{query} | Yes |
getProjectGlobalHttpsHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of HttpsHealthCheck resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks?{query} | Yes |
postProjectGlobalHttpsHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a HttpsHealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks?{query} | Yes |
deleteProjectGlobalHttpsHealthChecksHttpsHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpsHealthCheck, requestId, callback) | Deletes the specified HttpsHealthCheck resource. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks/{pathv2}?{query} | Yes |
getProjectGlobalHttpsHealthChecksHttpsHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpsHealthCheck, callback) | Returns the specified HttpsHealthCheck resource. Gets a list of available HTTPS health checks by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks/{pathv2}?{query} | Yes |
patchProjectGlobalHttpsHealthChecksHttpsHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpsHealthCheck, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks/{pathv2}?{query} | Yes |
putProjectGlobalHttpsHealthChecksHttpsHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, httpsHealthCheck, requestId, body, callback) | Updates a HttpsHealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/httpsHealthChecks/{pathv2}?{query} | Yes |
getProjectGlobalImages(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/images?{query} | Yes |
postProjectGlobalImages(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, forceCreate, requestId, body, callback) | Creates an image in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/images?{query} | Yes |
getProjectGlobalImagesFamilyFamily(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, family, callback) | Returns the latest image that is part of an image family and is not deprecated. | {base_path}/{version}/projects/{pathv1}/global/images/family/{pathv2}?{query} | Yes |
deleteProjectGlobalImagesImage(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, image, requestId, callback) | Deletes the specified image. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}?{query} | Yes |
getProjectGlobalImagesImage(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, image, callback) | Returns the specified image. Gets a list of available images by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}?{query} | Yes |
postProjectGlobalImagesImageDeprecate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, image, requestId, body, callback) | Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}/deprecate?{query} | Yes |
getProjectGlobalImagesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}/getIamPolicy?{query} | Yes |
postProjectGlobalImagesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}/setIamPolicy?{query} | Yes |
postProjectGlobalImagesResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}/setLabels?{query} | Yes |
postProjectGlobalImagesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/global/images/{pathv2}/testIamPermissions?{query} | Yes |
getProjectGlobalInstanceTemplates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of instance templates that are contained within the specified project. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates?{query} | Yes |
postProjectGlobalInstanceTemplates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates?{query} | Yes |
deleteProjectGlobalInstanceTemplatesInstanceTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, instanceTemplate, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates/{pathv2}?{query} | Yes |
getProjectGlobalInstanceTemplatesInstanceTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, instanceTemplate, callback) | Returns the specified instance template. Gets a list of available instance templates by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates/{pathv2}?{query} | Yes |
getProjectGlobalInstanceTemplatesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates/{pathv2}/getIamPolicy?{query} | Yes |
postProjectGlobalInstanceTemplatesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates/{pathv2}/setIamPolicy?{query} | Yes |
postProjectGlobalInstanceTemplatesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/global/instanceTemplates/{pathv2}/testIamPermissions?{query} | Yes |
getProjectGlobalInterconnectLocations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of interconnect locations available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/interconnectLocations?{query} | Yes |
getProjectGlobalInterconnectLocationsInterconnectLocation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, interconnectLocation, callback) | Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/interconnectLocations/{pathv2}?{query} | Yes |
getProjectGlobalInterconnects(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of interconnect available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/interconnects?{query} | Yes |
postProjectGlobalInterconnects(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a Interconnect in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/interconnects?{query} | Yes |
deleteProjectGlobalInterconnectsInterconnect(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, interconnect, requestId, callback) | Deletes the specified interconnect. | {base_path}/{version}/projects/{pathv1}/global/interconnects/{pathv2}?{query} | Yes |
getProjectGlobalInterconnectsInterconnect(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, interconnect, callback) | Returns the specified interconnect. Get a list of available interconnects by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/interconnects/{pathv2}?{query} | Yes |
patchProjectGlobalInterconnectsInterconnect(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, interconnect, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/interconnects/{pathv2}?{query} | Yes |
getProjectGlobalInterconnectsInterconnectGetDiagnostics(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, interconnect, callback) | Returns the interconnectDiagnostics for the specified interconnect. | {base_path}/{version}/projects/{pathv1}/global/interconnects/{pathv2}/getDiagnostics?{query} | Yes |
getProjectGlobalLicenseCodesLicenseCode(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, licenseCode, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenseCodes/{pathv2}?{query} | Yes |
postProjectGlobalLicenseCodesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenseCodes/{pathv2}/testIamPermissions?{query} | Yes |
getProjectGlobalLicenses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenses?{query} | Yes |
postProjectGlobalLicenses(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenses?{query} | Yes |
deleteProjectGlobalLicensesLicense(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, license, requestId, callback) | Deletes the specified license. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | {base_path}/{version}/projects/{pathv1}/global/licenses/{pathv2}?{query} | Yes |
getProjectGlobalLicensesLicense(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, license, callback) | Returns the specified License resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | {base_path}/{version}/projects/{pathv1}/global/licenses/{pathv2}?{query} | Yes |
getProjectGlobalLicensesResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, optionsRequestedPolicyVersion, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenses/{pathv2}/getIamPolicy?{query} | Yes |
postProjectGlobalLicensesResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenses/{pathv2}/setIamPolicy?{query} | Yes |
postProjectGlobalLicensesResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/licenses/{pathv2}/testIamPermissions?{query} | Yes |
getProjectGlobalNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of network endpoint groups that are located in the specified project. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups?{query} | Yes |
postProjectGlobalNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a network endpoint group in the specified project using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups?{query} | Yes |
deleteProjectGlobalNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, networkEndpointGroup, requestId, callback) | Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups/{pathv2}?{query} | Yes |
getProjectGlobalNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, networkEndpointGroup, callback) | Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups/{pathv2}?{query} | Yes |
postProjectGlobalNetworkEndpointGroupsNetworkEndpointGroupAttachNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, networkEndpointGroup, requestId, body, callback) | Attach a network endpoint to the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups/{pathv2}/attachNetworkEndpoints?{query} | Yes |
postProjectGlobalNetworkEndpointGroupsNetworkEndpointGroupDetachNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, networkEndpointGroup, requestId, body, callback) | Detach the network endpoint from the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups/{pathv2}/detachNetworkEndpoints?{query} | Yes |
postProjectGlobalNetworkEndpointGroupsNetworkEndpointGroupListNetworkEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, networkEndpointGroup, filter, maxResults, orderBy, pageToken, callback) | Lists the network endpoints in the specified network endpoint group. | {base_path}/{version}/projects/{pathv1}/global/networkEndpointGroups/{pathv2}/listNetworkEndpoints?{query} | Yes |
getProjectGlobalNetworks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of networks available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/networks?{query} | Yes |
postProjectGlobalNetworks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a network in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/networks?{query} | Yes |
deleteProjectGlobalNetworksNetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, callback) | Deletes the specified network. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}?{query} | Yes |
getProjectGlobalNetworksNetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, callback) | Returns the specified network. Gets a list of available networks by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}?{query} | Yes |
patchProjectGlobalNetworksNetwork(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, body, callback) | Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}?{query} | Yes |
postProjectGlobalNetworksNetworkAddPeering(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, body, callback) | Adds a peering to the specified network. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}/addPeering?{query} | Yes |
getProjectGlobalNetworksNetworkListPeeringRoutes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, direction = 'INCOMING', filter, maxResults, orderBy, pageToken, peeringName, region, callback) | Lists the peering routes exchanged over peering connection. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}/listPeeringRoutes?{query} | Yes |
postProjectGlobalNetworksNetworkRemovePeering(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, body, callback) | Removes a peering from the specified network. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}/removePeering?{query} | Yes |
postProjectGlobalNetworksNetworkSwitchToCustomMode(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, callback) | Switches the network mode from auto subnet mode to custom subnet mode. | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}/switchToCustomMode?{query} | Yes |
patchProjectGlobalNetworksNetworkUpdatePeering(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, network, requestId, body, callback) | Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes | {base_path}/{version}/projects/{pathv1}/global/networks/{pathv2}/updatePeering?{query} | Yes |
getProjectGlobalRoutes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of Route resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/routes?{query} | Yes |
postProjectGlobalRoutes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a Route resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/routes?{query} | Yes |
deleteProjectGlobalRoutesRoute(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, route, requestId, callback) | Deletes the specified Route resource. | {base_path}/{version}/projects/{pathv1}/global/routes/{pathv2}?{query} | Yes |
getProjectGlobalRoutesRoute(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, route, callback) | Returns the specified Route resource. Gets a list of available routes by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/routes/{pathv2}?{query} | Yes |
getProjectGlobalSecurityPolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | List all the policies that have been configured for the specified project. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies?{query} | Yes |
postProjectGlobalSecurityPolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a new policy in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies?{query} | Yes |
getProjectGlobalSecurityPoliciesListPreconfiguredExpressionSets(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Gets the current list of preconfigured Web Application Firewall (WAF) expressions. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/listPreconfiguredExpressionSets?{query} | Yes |
deleteProjectGlobalSecurityPoliciesSecurityPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, requestId, callback) | Deletes the specified policy. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}?{query} | Yes |
getProjectGlobalSecurityPoliciesSecurityPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, callback) | List all of the ordered rules present in a single specified policy. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}?{query} | Yes |
patchProjectGlobalSecurityPoliciesSecurityPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, requestId, body, callback) | Patches the specified policy with the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}?{query} | Yes |
postProjectGlobalSecurityPoliciesSecurityPolicyAddRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, body, callback) | Inserts a rule into a security policy. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}/addRule?{query} | Yes |
getProjectGlobalSecurityPoliciesSecurityPolicyGetRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, priority, callback) | Gets a rule at the specified priority. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}/getRule?{query} | Yes |
postProjectGlobalSecurityPoliciesSecurityPolicyPatchRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, priority, body, callback) | Patches a rule at the specified priority. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}/patchRule?{query} | Yes |
postProjectGlobalSecurityPoliciesSecurityPolicyRemoveRule(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, securityPolicy, priority, callback) | Deletes a rule at the specified priority. | {base_path}/{version}/projects/{pathv1}/global/securityPolicies/{pathv2}/removeRule?{query} | Yes |
getProjectGlobalSnapshots(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of Snapshot resources contained within the specified project. | {base_path}/{version}/projects/{pathv1}/global/snapshots?{query} | Yes |
getProjectGlobalSnapshotsResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}/getIamPolicy?{query} | Yes |
postProjectGlobalSnapshotsResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}/setIamPolicy?{query} | Yes |
postProjectGlobalSnapshotsResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}/setLabels?{query} | Yes |
postProjectGlobalSnapshotsResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}/testIamPermissions?{query} | Yes |
deleteProjectGlobalSnapshotsSnapshot(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, snapshot, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}?{query} | Yes |
getProjectGlobalSnapshotsSnapshot(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, snapshot, callback) | Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/snapshots/{pathv2}?{query} | Yes |
getProjectGlobalSslPolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Lists all the SSL policies that have been configured for the specified project. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies?{query} | Yes |
postProjectGlobalSslPolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Returns the specified SSL policy resource. Gets a list of available SSL policies by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies?{query} | Yes |
getProjectGlobalSslPoliciesListAvailableFeatures(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Lists all features that can be specified in the SSL policy when using custom profile. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies/listAvailableFeatures?{query} | Yes |
deleteProjectGlobalSslPoliciesSslPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, sslPolicy, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies/{pathv2}?{query} | Yes |
getProjectGlobalSslPoliciesSslPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, sslPolicy, callback) | Lists all of the ordered rules present in a single specified policy. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies/{pathv2}?{query} | Yes |
patchProjectGlobalSslPoliciesSslPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, sslPolicy, requestId, body, callback) | Patches the specified SSL policy with the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/sslPolicies/{pathv2}?{query} | Yes |
getProjectGlobalTargetGrpcProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Lists the TargetGrpcProxies for a project in the given scope. | {base_path}/{version}/projects/{pathv1}/global/targetGrpcProxies?{query} | Yes |
postProjectGlobalTargetGrpcProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/global/targetGrpcProxies?{query} | Yes |
deleteProjectGlobalTargetGrpcProxiesTargetGrpcProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetGrpcProxy, requestId, callback) | Deletes the specified TargetGrpcProxy in the given scope | {base_path}/{version}/projects/{pathv1}/global/targetGrpcProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetGrpcProxiesTargetGrpcProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetGrpcProxy, callback) | Returns the specified TargetGrpcProxy resource in the given scope. | {base_path}/{version}/projects/{pathv1}/global/targetGrpcProxies/{pathv2}?{query} | Yes |
patchProjectGlobalTargetGrpcProxiesTargetGrpcProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetGrpcProxy, requestId, body, callback) | Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | {base_path}/{version}/projects/{pathv1}/global/targetGrpcProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetSslProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetSslProxy resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies?{query} | Yes |
postProjectGlobalTargetSslProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a TargetSslProxy resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies?{query} | Yes |
deleteProjectGlobalTargetSslProxiesTargetSslProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, requestId, callback) | Deletes the specified TargetSslProxy resource. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetSslProxiesTargetSslProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, callback) | Returns the specified TargetSslProxy resource. Gets a list of available target SSL proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}?{query} | Yes |
postProjectGlobalTargetSslProxiesTargetSslProxySetBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, requestId, body, callback) | Changes the BackendService for TargetSslProxy. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}/setBackendService?{query} | Yes |
postProjectGlobalTargetSslProxiesTargetSslProxySetProxyHeader(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, requestId, body, callback) | Changes the ProxyHeaderType for TargetSslProxy. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}/setProxyHeader?{query} | Yes |
postProjectGlobalTargetSslProxiesTargetSslProxySetSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, requestId, body, callback) | Changes SslCertificates for TargetSslProxy. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}/setSslCertificates?{query} | Yes |
postProjectGlobalTargetSslProxiesTargetSslProxySetSslPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetSslProxy, requestId, body, callback) | Sets the SSL policy for TargetSslProxy. The SSL policy specifies the server-side support for SSL features. This affects connections between clients and the SSL proxy load balancer. They do not affect the connection between the load balancer and the backends. | {base_path}/{version}/projects/{pathv1}/global/targetSslProxies/{pathv2}/setSslPolicy?{query} | Yes |
getProjectGlobalTargetTcpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetTcpProxy resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies?{query} | Yes |
postProjectGlobalTargetTcpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, requestId, body, callback) | Creates a TargetTcpProxy resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies?{query} | Yes |
deleteProjectGlobalTargetTcpProxiesTargetTcpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetTcpProxy, requestId, callback) | Deletes the specified TargetTcpProxy resource. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies/{pathv2}?{query} | Yes |
getProjectGlobalTargetTcpProxiesTargetTcpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetTcpProxy, callback) | Returns the specified TargetTcpProxy resource. Gets a list of available target TCP proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies/{pathv2}?{query} | Yes |
postProjectGlobalTargetTcpProxiesTargetTcpProxySetBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetTcpProxy, requestId, body, callback) | Changes the BackendService for TargetTcpProxy. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies/{pathv2}/setBackendService?{query} | Yes |
postProjectGlobalTargetTcpProxiesTargetTcpProxySetProxyHeader(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, targetTcpProxy, requestId, body, callback) | Changes the ProxyHeaderType for TargetTcpProxy. | {base_path}/{version}/projects/{pathv1}/global/targetTcpProxies/{pathv2}/setProxyHeader?{query} | Yes |
getProjectRegions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of region resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions?{query} | Yes |
getProjectRegionsRegion(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, callback) | Returns the specified Region resource. Gets a list of available regions by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}?{query} | Yes |
getProjectRegionsRegionAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of autoscalers contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers?{query} | Yes |
patchProjectRegionsRegionAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, autoscaler, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers?{query} | Yes |
postProjectRegionsRegionAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates an autoscaler in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers?{query} | Yes |
putProjectRegionsRegionAutoscalers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, autoscaler, requestId, body, callback) | Updates an autoscaler in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers?{query} | Yes |
deleteProjectRegionsRegionAutoscalersAutoscaler(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, autoscaler, requestId, callback) | Deletes the specified autoscaler. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers/{pathv3}?{query} | Yes |
getProjectRegionsRegionAutoscalersAutoscaler(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, autoscaler, callback) | Returns the specified autoscaler. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/autoscalers/{pathv3}?{query} | Yes |
getProjectRegionsRegionBackendServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of regional BackendService resources available to the specified project in the given region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices?{query} | Yes |
postProjectRegionsRegionBackendServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices?{query} | Yes |
deleteProjectRegionsRegionBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, backendService, requestId, callback) | Deletes the specified regional BackendService resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices/{pathv3}?{query} | Yes |
getProjectRegionsRegionBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, backendService, callback) | Returns the specified regional BackendService resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices/{pathv3}?{query} | Yes |
patchProjectRegionsRegionBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, backendService, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices/{pathv3}?{query} | Yes |
putProjectRegionsRegionBackendServicesBackendService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, backendService, requestId, body, callback) | Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices/{pathv3}?{query} | Yes |
postProjectRegionsRegionBackendServicesBackendServiceGetHealth(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, backendService, body, callback) | Gets the most recent health check results for this regional BackendService. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/backendServices/{pathv3}/getHealth?{query} | Yes |
getProjectRegionsRegionDiskTypes(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of regional disk types available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/diskTypes?{query} | Yes |
getProjectRegionsRegionDiskTypesDiskType(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, diskType, callback) | Returns the specified regional disk type. Gets a list of available disk types by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/diskTypes/{pathv3}?{query} | Yes |
getProjectRegionsRegionDisks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of persistent disks contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks?{query} | Yes |
postProjectRegionsRegionDisks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, sourceImage, body, callback) | Creates a persistent regional disk in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks?{query} | Yes |
deleteProjectRegionsRegionDisksDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, requestId, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}?{query} | Yes |
getProjectRegionsRegionDisksDisk(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, callback) | Returns a specified regional persistent disk. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}?{query} | Yes |
postProjectRegionsRegionDisksDiskAddResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/addResourcePolicies?{query} | Yes |
postProjectRegionsRegionDisksDiskCreateSnapshot(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, requestId, body, callback) | Creates a snapshot of this regional disk. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/createSnapshot?{query} | Yes |
postProjectRegionsRegionDisksDiskRemoveResourcePolicies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, requestId, body, callback) | Removes resource policies from a regional disk. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/removeResourcePolicies?{query} | Yes |
postProjectRegionsRegionDisksDiskResize(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, disk, requestId, body, callback) | Resizes the specified regional persistent disk. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/resize?{query} | Yes |
getProjectRegionsRegionDisksResourceGetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/getIamPolicy?{query} | Yes |
postProjectRegionsRegionDisksResourceSetIamPolicy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/setIamPolicy?{query} | Yes |
postProjectRegionsRegionDisksResourceSetLabels(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, requestId, body, callback) | Sets the labels on the target regional disk. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/setLabels?{query} | Yes |
postProjectRegionsRegionDisksResourceTestIamPermissions(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, resource, body, callback) | Returns permissions that a caller has on the specified resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/disks/{pathv3}/testIamPermissions?{query} | Yes |
getProjectRegionsRegionHealthCheckServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthCheckServices?{query} | Yes |
postProjectRegionsRegionHealthCheckServices(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthCheckServices?{query} | Yes |
deleteProjectRegionsRegionHealthCheckServicesHealthCheckService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheckService, requestId, callback) | Deletes the specified regional HealthCheckService. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthCheckServices/{pathv3}?{query} | Yes |
getProjectRegionsRegionHealthCheckServicesHealthCheckService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheckService, callback) | Returns the specified regional HealthCheckService resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthCheckServices/{pathv3}?{query} | Yes |
patchProjectRegionsRegionHealthCheckServicesHealthCheckService(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheckService, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthCheckServices/{pathv3}?{query} | Yes |
getProjectRegionsRegionHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of HealthCheck resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks?{query} | Yes |
postProjectRegionsRegionHealthChecks(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a HealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks?{query} | Yes |
deleteProjectRegionsRegionHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheck, requestId, callback) | Deletes the specified HealthCheck resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks/{pathv3}?{query} | Yes |
getProjectRegionsRegionHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheck, callback) | Returns the specified HealthCheck resource. Gets a list of available health checks by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks/{pathv3}?{query} | Yes |
patchProjectRegionsRegionHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheck, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks/{pathv3}?{query} | Yes |
putProjectRegionsRegionHealthChecksHealthCheck(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, healthCheck, requestId, body, callback) | Updates a HealthCheck resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/healthChecks/{pathv3}?{query} | Yes |
getProjectRegionsRegionInstanceGroupManagers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of managed instance groups that are contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagers(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers?{query} | Yes |
deleteProjectRegionsRegionInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, callback) | Deletes the specified managed instance group and all of the instances in that group. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
getProjectRegionsRegionInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, callback) | Returns all of the details about the specified managed instance group. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
patchProjectRegionsRegionInstanceGroupManagersInstanceGroupManager(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerAbandonInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | 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 ...(description truncated) | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/abandonInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerApplyUpdatesToInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, body, callback) | Apply updates to selected instances the managed instance group. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/applyUpdatesToInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerCreateInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Creates instances with per-instance configs 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/createInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerDeleteInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | 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 listmanagedinsta...(description truncated) | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/deleteInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerDeletePerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, body, callback) | Deletes selected per-instance configs for the managed instance group. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/deletePerInstanceConfigs?{query} | Yes |
getProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerListErrors(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | Lists all errors thrown by actions on instances for a given regional managed instance group. The filter and orderBy query parameters are not supported. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/listErrors?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerListManagedInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/listManagedInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerListPerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, filter, maxResults, orderBy, pageToken, callback) | Lists all of the per-instance configs defined for the managed instance group. The orderBy query parameter is not supported. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/listPerInstanceConfigs?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerPatchPerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Insert or patch (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/patchPerInstanceConfigs?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerRecreateInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Flags the specified instances in the managed instance group to be immediately recreated. The instances are deleted and recreated using the current instance template for the managed instance group. 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 the recreating action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up t...(description truncated) | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/recreateInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerResize(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, size, requestId, callback) | 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 ha...(description truncated) | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/resize?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerSetInstanceTemplate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/setInstanceTemplate?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerSetTargetPools(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/setTargetPools?{query} | Yes |
postProjectRegionsRegionInstanceGroupManagersInstanceGroupManagerUpdatePerInstanceConfigs(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroupManager, requestId, body, callback) | Insert or update (for the ones that already exist) per-instance configs for the managed instance group. perInstanceConfig.instance serves as a key used to distinguish whether to perform insert or patch. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroupManagers/{pathv3}/updatePerInstanceConfigs?{query} | Yes |
getProjectRegionsRegionInstanceGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of instance group resources contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroups?{query} | Yes |
getProjectRegionsRegionInstanceGroupsInstanceGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroup, callback) | Returns the specified instance group resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroups/{pathv3}?{query} | Yes |
postProjectRegionsRegionInstanceGroupsInstanceGroupListInstances(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroup, filter, maxResults, orderBy, pageToken, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroups/{pathv3}/listInstances?{query} | Yes |
postProjectRegionsRegionInstanceGroupsInstanceGroupSetNamedPorts(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, instanceGroup, requestId, body, callback) | Sets the named ports for the specified regional instance group. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/instanceGroups/{pathv3}/setNamedPorts?{query} | Yes |
getProjectRegionsRegionNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of regional network endpoint groups available to the specified project in the given region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/networkEndpointGroups?{query} | Yes |
postProjectRegionsRegionNetworkEndpointGroups(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a network endpoint group in the specified project using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/networkEndpointGroups?{query} | Yes |
deleteProjectRegionsRegionNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, networkEndpointGroup, requestId, callback) | Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/networkEndpointGroups/{pathv3}?{query} | Yes |
getProjectRegionsRegionNetworkEndpointGroupsNetworkEndpointGroup(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, networkEndpointGroup, callback) | Returns the specified network endpoint group. Gets a list of available network endpoint groups by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/networkEndpointGroups/{pathv3}?{query} | Yes |
getProjectRegionsRegionNotificationEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Lists the NotificationEndpoints for a project in the given region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/notificationEndpoints?{query} | Yes |
postProjectRegionsRegionNotificationEndpoints(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/notificationEndpoints?{query} | Yes |
deleteProjectRegionsRegionNotificationEndpointsNotificationEndpoint(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, notificationEndpoint, requestId, callback) | Deletes the specified NotificationEndpoint in the given region | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/notificationEndpoints/{pathv3}?{query} | Yes |
getProjectRegionsRegionNotificationEndpointsNotificationEndpoint(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, notificationEndpoint, callback) | Returns the specified NotificationEndpoint resource in the given region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/notificationEndpoints/{pathv3}?{query} | Yes |
getProjectRegionsRegionOperations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of Operation resources contained within the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/operations?{query} | Yes |
deleteProjectRegionsRegionOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, operation, callback) | Deletes the specified region-specific Operations resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/operations/{pathv3}?{query} | Yes |
getProjectRegionsRegionOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, operation, callback) | Retrieves the specified region-specific Operations resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/operations/{pathv3}?{query} | Yes |
postProjectRegionsRegionOperationsOperationWait(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, operation, callback) | 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:
| {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/operations/{pathv3}/wait?{query} | Yes |
getProjectRegionsRegionSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of SslCertificate resources available to the specified project in the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/sslCertificates?{query} | Yes |
postProjectRegionsRegionSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a SslCertificate resource in the specified project and region using the data included in the request | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/sslCertificates?{query} | Yes |
deleteProjectRegionsRegionSslCertificatesSslCertificate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, sslCertificate, requestId, callback) | Deletes the specified SslCertificate resource in the region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/sslCertificates/{pathv3}?{query} | Yes |
getProjectRegionsRegionSslCertificatesSslCertificate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, sslCertificate, callback) | Returns the specified SslCertificate resource in the specified region. Get a list of available SSL certificates by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/sslCertificates/{pathv3}?{query} | Yes |
getProjectRegionsRegionTargetHttpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpProxies?{query} | Yes |
postProjectRegionsRegionTargetHttpProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpProxies?{query} | Yes |
deleteProjectRegionsRegionTargetHttpProxiesTargetHttpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpProxy, requestId, callback) | Deletes the specified TargetHttpProxy resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpProxies/{pathv3}?{query} | Yes |
getProjectRegionsRegionTargetHttpProxiesTargetHttpProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpProxy, callback) | Returns the specified TargetHttpProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpProxies/{pathv3}?{query} | Yes |
postProjectRegionsRegionTargetHttpProxiesTargetHttpProxySetUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpProxy, requestId, body, callback) | Changes the URL map for TargetHttpProxy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpProxies/{pathv3}/setUrlMap?{query} | Yes |
getProjectRegionsRegionTargetHttpsProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies?{query} | Yes |
postProjectRegionsRegionTargetHttpsProxies(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies?{query} | Yes |
deleteProjectRegionsRegionTargetHttpsProxiesTargetHttpsProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpsProxy, requestId, callback) | Deletes the specified TargetHttpsProxy resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies/{pathv3}?{query} | Yes |
getProjectRegionsRegionTargetHttpsProxiesTargetHttpsProxy(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpsProxy, callback) | Returns the specified TargetHttpsProxy resource in the specified region. Gets a list of available target HTTP proxies by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies/{pathv3}?{query} | Yes |
postProjectRegionsRegionTargetHttpsProxiesTargetHttpsProxySetSslCertificates(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpsProxy, requestId, body, callback) | Replaces SslCertificates for TargetHttpsProxy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies/{pathv3}/setSslCertificates?{query} | Yes |
postProjectRegionsRegionTargetHttpsProxiesTargetHttpsProxySetUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, targetHttpsProxy, requestId, body, callback) | Changes the URL map for TargetHttpsProxy. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/targetHttpsProxies/{pathv3}/setUrlMap?{query} | Yes |
getProjectRegionsRegionUrlMaps(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of UrlMap resources available to the specified project in the specified region. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps?{query} | Yes |
postProjectRegionsRegionUrlMaps(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, requestId, body, callback) | Creates a UrlMap resource in the specified project using the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps?{query} | Yes |
deleteProjectRegionsRegionUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, urlMap, requestId, callback) | Deletes the specified UrlMap resource. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps/{pathv3}?{query} | Yes |
getProjectRegionsRegionUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, urlMap, callback) | Returns the specified UrlMap resource. Gets a list of available URL maps by making a list() request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps/{pathv3}?{query} | Yes |
patchProjectRegionsRegionUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, urlMap, requestId, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps/{pathv3}?{query} | Yes |
putProjectRegionsRegionUrlMapsUrlMap(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, urlMap, requestId, body, callback) | Updates the specified UrlMap resource with the data included in the request. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps/{pathv3}?{query} | Yes |
postProjectRegionsRegionUrlMapsUrlMapValidate(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, region, urlMap, body, callback) | 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. | {base_path}/{version}/projects/{pathv1}/regions/{pathv2}/urlMaps/{pathv3}/validate?{query} | Yes |
getProjectZones(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, filter, maxResults, orderBy, pageToken, callback) | Retrieves the list of Zone resources available to the specified project. | {base_path}/{version}/projects/{pathv1}/zones?{query} | Yes |
getProjectZonesZone(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, callback) | Returns the specified Zone resource. Gets a list of available zones by making a list() request. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}?{query} | Yes |
getProjectZonesZoneOperations(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, filter, maxResults, orderBy, pageToken, callback) | Retrieves a list of Operation resources contained within the specified zone. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/operations?{query} | Yes |
deleteProjectZonesZoneOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, operation, callback) | Deletes the specified zone-specific Operations resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/operations/{pathv3}?{query} | Yes |
getProjectZonesZoneOperationsOperation(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, operation, callback) | Retrieves the specified zone-specific Operations resource. | {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/operations/{pathv3}?{query} | Yes |
postProjectZonesZoneOperationsOperationWait(alt = 'json', fields, key, oauthToken, prettyPrint, quotaUser, userIp, project, zone, operation, callback) | 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:
| {base_path}/{version}/projects/{pathv1}/zones/{pathv2}/operations/{pathv3}/wait?{query} | Yes |
addFirewallPolicyAssociation(resourceId, association, requestId, replaceExistingAssociation, callback) | Inserts an association for the specified firewall policy | {base_path}/{version}/locations/global/{pathv1}/addAssociation?{query} | Yes |
addFirewallPolicyRule(resourceId, rule, requestId, callback) | Inserts a rule into a firewall policy | {base_path}/{version}/locations/global/{pathv1}/addRule?{query} | Yes |
cloneFirewallPolicyRule(resourceId, requestId, sourceFirewallPolicy, callback) | Copies rules to the specified firewall policy | {base_path}/{version}/locations/global/{pathv1}/cloneRules?{query} | Yes |
deleteFirewallPolicy(resourceId, requestId, callback) | Deletes the specified policy. | {base_path}/{version}/locations/global/{pathv1}?{query} | Yes |
getFirewallPolicy(resourceId, callback) | Returns the specified firewall policy | {base_path}/{version}/locations/global/{pathv1}?{query} | Yes |
getFirewallPolicyAssociation(resourceId, name, callback) | Gets an association with the specified name. | {base_path}/{version}/locations/global/{pathv1}/getAssociation?{query} | Yes |
getFirewallPolicyIamPolicy(resourceId, optionsRequestedPolicyVersion, callback) | Gets the access control policy for a resource. May be empty if no such policy or resource exists. | {base_path}/{version}/locations/global/{pathv1}/getIamPolicy?{query} | Yes |
getFirewallPolicyRule(resourceId, priority, callback) | Gets a rule of the specified priority. | {base_path}/{version}/locations/global/{pathv1}/getRule?{query} | Yes |
insertFirewallPolicy(policy, requestId, parentId, callback) | Creates a new policy in the specified project using the data included in the request. | {base_path}/{version}/locations/global/firewallPolicies?{query} | Yes |
listFirewallPolicy(maxResults, pageToken, filter, orderBy, returnPartialSuccess, parentId, callback) | Lists all the policies that have been configured for the specified folder or organization | {base_path}/{version}/locations/global/firewallPolicies?{query} | Yes |
listFirewallPolicyAssociations(targetResource, callback) | Lists associations of a specified target, i.e., organization or folder. | {base_path}/{version}/locations/global/firewallPolicies/listAssociations?{query} | Yes |
moveFirewallPolicy(resourceId, requestId, parentId, callback) | Moves the specified firewall policy | {base_path}/{version}/locations/global/{pathv1}/move?{query} | Yes |
patchFirewallPolicy(resourceId, policy, requestId, callback) | Patches the specified policy with the data included in the request. | {base_path}/{version}/locations/global/{pathv1}?{query} | Yes |
patchFirewallPolicyRule(resourceId, rule, requestId, priority, callback) | Patches a rule of the specified priority. | {base_path}/{version}/locations/global/{pathv1}/patchRule?{query} | Yes |
removeFirewallPolicyAssociation(resourceId, requestId, name, callback) | Removes an association for the specified firewall policy. | {base_path}/{version}/locations/global/{pathv1}/removeAssociation?{query} | Yes |
removeFirewallPolicyRule(resourceId, requestId, priority, callback) | Deletes a rule of the specified priority | {base_path}/{version}/locations/global/{pathv1}/removeRule?{query} | Yes |
setFirewallPolicyIamPolicy(resourceId, iamPolicy, callback) | Sets the access control policy on the specified resource. Replaces any existing policy. | {base_path}/{version}/locations/global/{pathv1}/setIamPolicy?{query} | Yes |
testFirewallPolicyIamPermissions(resourceId, iamPolicy, callback) | Returns permissions that a caller has on the specified resource | {base_path}/{version}/locations/global/{pathv1}/testIamPermissions?{query} | Yes |
Authentication
This document will go through the steps for authenticating the Google Cloud Platform Compute adapter with Google Token Security. Properly configuring the properties for an adapter in IAP is critical for getting the adapter online. You can read more about adapter authentication HERE.
Companies periodically change authentication methods to provide better security. As this happens this section should be updated and contributed/merge back into the adapter repository.
Google Token Authentication
The Google Cloud Platform Compute adapter authenticates with a Google token.
STEPS
- Ensure you have access to a Google Cloud Platform Compute server and that it is running
- Follow the steps in the README.md to import the adapter into IAP if you have not already done so
- Use the properties below for the
properties.authentication
field
Using key in service config (Needed for Cloud Instance)
"authentication": {
"auth_method": "no_authentication",
"configureGtoken": {
"email": "sample@email.com",
"key": "-----BEGIN PRIVATE KEY-----\nMIIEv********--\n",
"scope": "https://www.********",
"eagerRefreshThresholdMillis": 300000,
"project_id": "myprojectid"
}
}
Using keyfile in service config
"authentication": {
"auth_method": "no_authentication",
"configureGtoken": {
"email": "",
"scope": "https://www.googleapis.com/auth/cloud-platform",
"sub": "",
"keyFile": "/opt/pronghorn/RENAME_TO_YOUR_KEYFILE.json",
"key": "",
"additionalClaims": "",
"eagerRefreshThresholdMillis": 300000
}
}
you can leave all of the other properties in the authentication section, they will not be used for Google Cloud Platform Compute Google token authentication. 4. Restart the adapter. If your properties were set correctly, the adapter should go online.
Troubleshooting
- Make sure you copied over the correct Googgle properties as these are used to retrieve the token.
- Turn on debug level logs for the adapter in IAP Admin Essentials.
- Turn on auth_logging for the adapter in IAP Admin Essentials (adapter properties).
- Investigate the logs - in particular:
- The FULL REQUEST log to make sure the proper headers are being sent with the request.
- The FULL BODY log to make sure the payload is accurate.
- The CALL RETURN log to see what the other system is telling us.
- Credentials should be masked by the adapter so make sure you verify the username and password - including that there are erroneous spaces at the front or end.
- Remember when you are done to turn auth_logging off as you do not want to log credentials.
Additional Information
Enhancements
Adding a Second Instance of an Adapter
You can add a second instance of this adapter without adding new code on the file system. To do this go into the IAP Admin Essentials and add a new service config for this adapter. The two instances of the adapter should have unique ids. In addition, they should point to different instances (unique host and port) of the other system.
Adding Adapter Calls
There are multiple ways to add calls to an existing adapter.
The easiest way would be to use the Adapter Builder update process. This process takes in a Swagger or OpenAPI document, allows you to select the calls you want to add and then generates a zip file that can be used to update the adapter. Once you have the zip file simply put it in the adapter directory and execute npm run adapter:update
.
mv updatePackage.zip adapter-gcp_compute
cd adapter-gcp_compute
npm run adapter:update
If you do not have a Swagger or OpenAPI document, you can use a Postman Collection and convert that to an OpenAPI document using APIMatic and then follow the first process.
If you want to manually update the adapter that can also be done the key thing is to make sure you update all of the right files. Within the entities directory you will find 1 or more entities. You can create a new entity or add to an existing entity. Each entity has an action.json file, any new call will need to be put in the action.json file. It will also need to be added to the enum for the ph_request_type in the appropriate schema files. Once this configuration is complete you will need to add the call to the adapter.js file and, in order to make it available as a workflow task in IAP, it should also be added to the pronghorn.json file. You can optionally add it to the unit and integration test files. There is more information on how to work on each of these files in the Adapter Technical Resources on our Documentation Site.
Files to update
* entities/<entity>/action.json: add an action
* entities/<entity>/schema.json (or the schema defined on the action): add action to the enum for ph_request_type
* adapter.js: add the new method and make sure it calls the proper entity and action
* pronghorn.json: add the new method
* test/unit/adapterTestUnit.js (optional but best practice): add unit test(s) - function is there, any required parameters error when not passed in
* test/integration/adapterTestIntegration.js (optional but best practice): add integration test
Adding Adapter Properties
While changing adapter properties is done in the service instance configuration section of IAP, adding properties has to be done in the adapter. To add a property you should edit the propertiesSchema.json with the proper information for the property. In addition, you should modify the sampleProperties to have the new property in it.
Files to update
* propertiesSchema.json: add the new property and how it is defined
* sampleProperties: add the new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
Changing Adapter Authentication
Often an adapter is built before knowing the authentication and authentication processes can also change over time. The adapter supports many different kinds of authentication but it does require configuration. Some forms of authentication can be defined entirely with the adapter properties but others require configuration.
Files to update
* entities/.system/action.json: change the getToken action as needed
* entities/.system/schemaTokenReq.json: add input parameters (external name is name in other system)
* entities/.system/schemaTokenResp.json: add response parameters (external name is name in other system)
* propertiesSchema.json: add any new property and how it is defined
* sampleProperties: add any new property with a default value
* test/unit/adapterTestUnit.js (optional but best practice): add the property to the global properties
* test/integration/adapterTestIntegration.js (optional but best practice): add the property to the global properties
Enhancing Adapter Integration Tests
The adapter integration tests are written to be able to test in either stub (standalone) mode or integrated to the other system. However, if integrating to the other system, you may need to provide better data than what the adapter provides by default as that data is likely to fail for create and update. To provide better data, edit the adapter integration test file. Make sure you do not remove the marker and keep custom code below the marker so you do not impact future migrations. Once the edits are complete, run the integration test as it instructs you to above. When you run integrated to the other system, you can also save mockdata for future use by changing the isSaveMockData flag to true.
Files to update
* test/integration/adapterTestIntegration.js: add better data for the create and update calls so that they will not fail.
As mentioned previously, for most of these changes as well as other possible changes, there is more information on how to work on an adapter in the Adapter Technical Resources on our Documentation Site.
Contributing
First off, thanks for taking the time to contribute!
The following is a set of rules for contributing.
Code of Conduct
This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to support@itential.com.
How to Contribute
Follow the contributing guide (here)[https://gitlab.com/itentialopensource/adapters/contributing-guide]
Helpful Links
Node Scripts
There are several node scripts that now accompany the adapter. These scripts are provided to make several activities easier. Many of these scripts can have issues with different versions of IAP as they have dependencies on IAP and Mongo. If you have issues with the scripts please report them to the Itential Adapter Team. Each of these scripts are described below.
Run | Description |
---|---|
npm run adapter:install | Provides an easier way to install the adapter. |
npm run adapter:checkMigrate | Checks whether your adapter can and should be migrated to the latest foundation. |
npm run adapter:findPath | Can be used to see if the adapter supports a particular API call. |
npm run adapter:migrate | Provides an easier way to update your adapter after you download the migration zip from Itential DevSite. |
npm run adapter:update | Provides an easier way to update your adapter after you download the update zip from Itential DevSite. |
npm run adapter:revert | Allows you to revert after a migration or update if it resulted in issues. |
npm run troubleshoot | Provides a way to troubleshoot the adapter - runs connectivity, healthcheck and basic get. |
npm run connectivity | Provides a connectivity check to the Servicenow system. |
npm run healthcheck | Checks whether the configured healthcheck call works to Servicenow. |
npm run basicget | Checks whether the basic get calls works to Servicenow. |
Troubleshoot
Run npm run troubleshoot
to start the interactive troubleshooting process. The command allows you to verify and update connection, authentication as well as healthcheck configuration. After that it will test these properties by sending HTTP request to the endpoint. If the tests pass, it will persist these changes into IAP.
You also have the option to run individual commands to perform specific test:
npm run healthcheck
will perform a healthcheck request of with current setting.npm run basicget
will perform some non-parameter GET request with current setting.npm run connectivity
will perform networking diagnostics of the adatper endpoint.
Connectivity Issues
- You can run the adapter troubleshooting script which will check connectivity, run the healthcheck and run basic get calls.
npm run troubleshoot
- Verify the adapter properties are set up correctly.
Go into the Itential Platform GUI and verify/update the properties
- Verify there is connectivity between the Itential Platform Server and GcpCompute Server.
ping the ip address of GcpCompute server
try telnet to the ip address port of GcpCompute
execute a curl command to the other system
- Verify the credentials provided for GcpCompute.
login to GcpCompute using the provided credentials
- Verify the API of the call utilized for GcpCompute Healthcheck.
Go into the Itential Platform GUI and verify/update the properties
Functional Issues
Adapter logs are located in /var/log/pronghorn
. In older releases of the Itential Platform, there is a pronghorn.log
file which contains logs for all of the Itential Platform. In newer versions, adapters can be configured to log into their own files.