Method: previewFeatures.get

Returns the details of the given PreviewFeature.

HTTP request

GET https://compute.googleapis.com/compute/beta/projects/{project}/global/previewFeatures/{previewFeature}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
project

string

Project ID for this request.
previewFeature

string

Name of the PreviewFeature for this request.

Request body

The request body must be empty.

Response body

Represents a single Google Compute Engine preview feature.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "activationStatus": enum,
  "status": {
    "description": string,
    "releaseStatus": {
      "stage": enum,
      "updateDate": {
        "year": integer,
        "month": integer,
        "day": integer
      }
    }
  },
  "selfLink": string,
  "rolloutOperation": {
    "rolloutInput": {
      "retryUuid": string,

      // Union field rollout_plan can be only one of the following:
      "name": string,
      "predefinedRolloutPlan": enum
      // End of list of possible types for union field rollout_plan.
    },
    "rolloutStatus": {
      "ongoingRollouts": [
        {
          "rollout": string,
          "rolloutPlan": string,
          "status": {
            "description": string,
            "releaseStatus": {
              "stage": enum,
              "updateDate": {
                "year": integer,
                "month": integer,
                "day": integer
              }
            }
          }
        }
      ],
      "previousRollout": {
        "rollout": string,
        "rolloutPlan": string,
        "status": {
          "description": string,
          "releaseStatus": {
            "stage": enum,
            "updateDate": {
              "year": integer,
              "month": integer,
              "day": integer
            }
          }
        }
      }
    }
  },
  "kind": string
}
Fields
id

string (uint64 format)

[Output Only] The unique identifier for the resource. This identifier is defined by the server.
creationTimestamp

string

[Output Only] Creation timestamp in RFC3339 text format.
name

string

Name of the feature.
description

string

[Output Only] Description of the feature.
activationStatus

enum

Specifies whether the feature is enabled or disabled.
status

object

[Output only] Status of the feature.
status.description

string

[Output Only] The description of the feature.
status.releaseStatus

object
status.releaseStatus.stage

enum

[Output Only] The stage of the feature.
status.releaseStatus.updateDate

object

Output only. The last date when a feature transitioned between ReleaseStatuses.
status.releaseStatus.updateDate.year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
status.releaseStatus.updateDate.month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
status.releaseStatus.updateDate.day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
rolloutOperation

object

Rollout operation of the feature.
rolloutOperation.rolloutInput

object
rolloutOperation.rolloutInput.name

string

The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
rolloutOperation.rolloutInput.predefinedRolloutPlan

enum

Predefined rollout plan.
rolloutOperation.rolloutInput.retryUuid

string

The UUID of the retry action. Only needed if this is a retry for an existing rollout. This can be used after the user canceled a rollout and want to retry it with no changes.
rolloutOperation.rolloutStatus

object
rolloutOperation.rolloutStatus.ongoingRollouts[]

object

Output only. The ongoing rollout resources. There can be multiple ongoing rollouts for a resource.
rolloutOperation.rolloutStatus.ongoingRollouts[].rollout

string

The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/.
rolloutOperation.rolloutStatus.ongoingRollouts[].rolloutPlan

string

The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
rolloutOperation.rolloutStatus.ongoingRollouts[].status

object

The status of the rollout.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.description

string

[Output Only] The description of the feature.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus

object
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus.stage

enum

[Output Only] The stage of the feature.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus.updateDate

object

Output only. The last date when a feature transitioned between ReleaseStatuses.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus.updateDate.year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus.updateDate.month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
rolloutOperation.rolloutStatus.ongoingRollouts[].status.releaseStatus.updateDate.day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
rolloutOperation.rolloutStatus.previousRollout

object

Output only. The last completed rollout resource. This field will not be populated until the first rollout is completed.
rolloutOperation.rolloutStatus.previousRollout.rollout

string

The name of the rollout Ex. organizations//locations/global/rollouts/ Ex. folders//locations/global/rollouts/ Ex. projects//locations/global/rollouts/.
rolloutOperation.rolloutStatus.previousRollout.rolloutPlan

string

The name of the rollout plan Ex. organizations//locations/global/rolloutPlans/ Ex. folders//locations/global/rolloutPlans/ Ex. projects//locations/global/rolloutPlans/.
rolloutOperation.rolloutStatus.previousRollout.status

object

The status of the rollout.
rolloutOperation.rolloutStatus.previousRollout.status.description

string

[Output Only] The description of the feature.
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus

object
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus.stage

enum

[Output Only] The stage of the feature.
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus.updateDate

object

Output only. The last date when a feature transitioned between ReleaseStatuses.
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus.updateDate.year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus.updateDate.month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
rolloutOperation.rolloutStatus.previousRollout.status.releaseStatus.updateDate.day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
kind

string

[Output only] The type of the feature. Always "compute#previewFeature" for preview features.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

  • compute.previewFeatures.get

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.