Compute Engine API (compute:v1)

▼ ▲ compute.globalForwardingRules.get

Parameters :

view

Location : query

Type : string

Enum Descriptions :

• The default view of a ForwardingRule, which includes the basic fields.
• The full view, including the ForwardingRule.`attached_extensions` field.

Enum :

• BASIC
• FULL

▼ ▲ compute.forwardingRules.get

Parameters :

view

Location : query

Type : string

Enum Descriptions :

• The default view of a ForwardingRule, which includes the basic fields.
• The full view, including the ForwardingRule.`attached_extensions` field.

Enum :

• BASIC
• FULL

▼ ▲ compute.rollouts.pause

Path : projects/{project}/global/rollouts/{rollout}/pause

Flat Path : projects/{project}/global/rollouts/{rollout}/pause

HTTP Method : POST

Parameters :

etag

Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

Location : query

Type : string

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to pause.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Pauses a Rollout.

▼ ▲ compute.rollouts.resume

Path : projects/{project}/global/rollouts/{rollout}/resume

Flat Path : projects/{project}/global/rollouts/{rollout}/resume

HTTP Method : POST

Parameters :

etag

Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

Location : query

Type : string

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to resume.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Resumes a Rollout.

▼ ▲ compute.rollouts.advance

Path : projects/{project}/global/rollouts/{rollout}/advance

Flat Path : projects/{project}/global/rollouts/{rollout}/advance

HTTP Method : POST

Parameters :

currentWaveNumber

Description : Required. Wave number of the current wave.

Location : query

Type : string

Format : int64

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to advance.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Advances a Rollout to the next wave, or completes it if no waves remain.

▼ ▲ compute.rollouts.pause

Path : projects/{project}/global/rollouts/{rollout}/pause

Flat Path : projects/{project}/global/rollouts/{rollout}/pause

HTTP Method : POST

Parameters :

etag

Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

Location : query

Type : string

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to pause.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Pauses a Rollout.

▼ ▲ compute.rollouts.resume

Path : projects/{project}/global/rollouts/{rollout}/resume

Flat Path : projects/{project}/global/rollouts/{rollout}/resume

HTTP Method : POST

Parameters :

etag

Description : The etag of the Rollout. If this is provided, the request will only succeed if the etag matches the current etag of the Rollout.

Location : query

Type : string

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to resume.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Resumes a Rollout.

▼ ▲ compute.rollouts.advance

Path : projects/{project}/global/rollouts/{rollout}/advance

Flat Path : projects/{project}/global/rollouts/{rollout}/advance

HTTP Method : POST

Parameters :

currentWaveNumber

Description : Required. Wave number of the current wave.

Location : query

Type : string

Format : int64

project

Description : Required. Project ID for this request.

Pattern : (?:(?:[-a-z0-9]{1,63}\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))

Location : path

Required : Yes

Type : string

requestId

Description : An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Location : query

Type : string

rollout

Description : Required. Name of the Rollout resource to advance.

Pattern : [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}

Location : path

Required : Yes

Type : string

Parameter Order :

• project
• rollout

Scopes :

• https://www.googleapis.com/auth/cloud-platform
• https://www.googleapis.com/auth/compute

Description : Advances a Rollout to the next wave, or completes it if no waves remain.

▼ ▲ compute.globalForwardingRules.get

Parameters :

view

Location : query

Type : string

Enum Descriptions :

• The default view of a ForwardingRule, which includes the basic fields.
• The full view, including the ForwardingRule.`attached_extensions` field.

Enum :

• BASIC
• FULL

▼ ▲ compute.forwardingRules.get

Parameters :

view

Location : query

Type : string

Enum Descriptions :

• The default view of a ForwardingRule, which includes the basic fields.
• The full view, including the ForwardingRule.`attached_extensions` field.

Enum :

• BASIC
• FULL