category: IT Services provider: Google commonfields: id: Google Cloud Compute version: -1 configuration: - display: Service Account Private Key file contents (JSON) name: service type: 4 hidden: true required: false section: Collect - displaypassword: Service Account Private Key file contents (JSON) name: credentials_service_account_json hiddenusername: true type: 9 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 required: false section: Connect advanced: true - additionalinfo: What is the top level object to search in (usually a project or organization in format of organization/XX). display: Default Search Scope name: default_search_scope type: 0 required: false section: Collect description: Google Compute Engine delivers virtual machines running in Google's innovative data centers and worldwide fiber network. Compute Engine's tooling and workflow support enable scaling from single instances to global, load-balanced cloud computing. display: Google Cloud Compute name: Google Cloud Compute script: commands: - arguments: - description: ' The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.' name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: The name of the zone for this request. name: zone required: true - description: Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the 'tags.items' field. name: tags - description: Specifies a fingerprint for this request, which is essentially a hash of the tags' contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. name: tagsFingerprint - auto: PREDEFINED description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. name: canIpForward predefined: - 'true' - 'false' - description: 'The machine type EX: n1-standard-1 or custom-4-5120.' name: machine_type - description: URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. name: network - description: The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. name: subnetwork - description: An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. name: networkIP - description: Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. name: networkInterfacesfingerprint - auto: PREDEFINED description: This will set accessConfigs to type ONE_TO_ONE_NAT and name to External NAT. name: externalInternetAccess predefined: - 'true' - 'false' - description: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. name: externalNatIP - auto: PREDEFINED description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. name: setPublicPtr predefined: - 'true' - 'false' - description: The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. name: publicPtrDomainName - auto: PREDEFINED description: 'This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.' name: networkTier predefined: - PREMIUM - STANDARD - description: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 0.0.0.0), a netmask (e.g. /24) or a CIDR format string (e.g. 0.0.0.0/24). name: ipCidrRange - description: Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. name: subnetworkRangeName - auto: PREDEFINED description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. name: diskType predefined: - PERSISTENT - SCRATCH - auto: PREDEFINED description: The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. name: diskMode predefined: - READ_WRITE - READ_ONLY - description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. name: diskSource - description: Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. name: diskDeviceName - auto: PREDEFINED description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. name: diskBoot predefined: - 'true' - 'false' - description: Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. name: initializeParamsDiskName - description: 'The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD.' name: initializeParamsSourceImage - description: Specifies the size of the disk in base-2 GB. name: initializeParamsdiskSizeGb - description: 'Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/diskTypes/pd-standard Other values include pd-ssd and local-ssd. If you define this field, you can provide either the full or partial URL. ' name: initializeParamsDiskType - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: initializeParamsSourceImageEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: initializeParamsSourceImageEncryptionKeykmsKeyName - description: 'Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. EX: key=abc,value=123;key=abc,value=123.' name: initializeParamsDiskLabels - description: An optional description. Provide this property when creating the disk. name: initializeParamsDiskDescription - auto: PREDEFINED description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). name: diskAutodelete predefined: - 'true' - 'false' - auto: PREDEFINED description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. name: diskInterface predefined: - SCSI - NVME - description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. comma separated. name: diskGuestOsFeatures - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: diskEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: diskEncryptionKeyKmsKeyName - description: 'The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. EX: key=abc,value=123;key=abc,value=123.' name: metadataItems - description: Email address of the service account. name: serviceAccountEmail - description: The list of scopes to be made available for this service account. name: serviceAccountscopes - auto: PREDEFINED description: Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. name: schedulingOnHostMaintenance predefined: - MIGRATE - TERMINATE - auto: PREDEFINED description: Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. name: schedulingAutomaticRestart predefined: - 'true' - 'false' - auto: PREDEFINED description: Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. name: schedulingPreemptible predefined: - 'true' - 'false' - description: Labels to apply to this instance. These can be later modified by the setLabels method. key=abc,value=123;key=abc,value=123. name: labels - description: A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. name: labelFingerprint - description: 'Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' name: minCpuPlatform - description: 'Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.' name: guestAcceleratorsAcceleratorType - description: The number of the guest accelerator cards exposed to this instance. name: guestAcceleratorsAcceleratorCount - auto: PREDEFINED description: Whether the resource should be protected against deletion. name: deletionProtection predefined: - 'true' - 'false' description: Creates an instance resource in the specified project using the data included in the request. name: gcp-compute-insert-instance outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Project ID for this request. name: project required: true - description: Name of the image family to search for. name: family required: true description: Returns the latest image that is part of an image family and is not deprecated. name: gcp-compute-get-image-from-family outputs: - contextPath: GoogleCloudCompute.Images.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Images.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Images.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Images.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Images.sourceType description: The type of the image used to create this disk. The default and only value is RAW. type: string - contextPath: GoogleCloudCompute.Images.rawDisk description: The parameters of the raw disk image. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.source description: The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.sha1Checksum description: An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.containerType description: The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.deprecated description: The deprecation status associated with this image. type: string - contextPath: GoogleCloudCompute.Images.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Images.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.status description: The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. type: string - contextPath: GoogleCloudCompute.Images.archiveSizeBytes description: Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). type: string - contextPath: GoogleCloudCompute.Images.diskSizeGb description: Size of the image when restored onto a persistent disk (in GB). type: string - contextPath: GoogleCloudCompute.Images.sourceDisk description: 'URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk , projects/project/zones/zone/disks/disk , zones/zone/disks/disk.' type: string - contextPath: GoogleCloudCompute.Images.sourceDiskId description: The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. type: string - contextPath: GoogleCloudCompute.Images.licenses description: Any applicable license URI. type: string - contextPath: GoogleCloudCompute.Images.family description: The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey description: Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Images.labels description: Labels to apply to this image. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Images.labelFingerprint description: A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.licenseCodes description: Integer license codes indicating which licenses are attached to this image. type: string - contextPath: GoogleCloudCompute.Images.sourceImage description: URL of the source image used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceImageId description: The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.sha256 description: ' The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshot description: URL of the source snapshot used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotId description: ' The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.kind description: Type of the resource. Always compute#image for images. type: string - arguments: - description: Name of the network to return. name: network required: true description: Returns the specified network. name: gcp-compute-get-network outputs: - contextPath: GoogleCloudCompute.Networks.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Networks.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Networks.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Networks.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Networks.gatewayIPv4 description: The gateway address for default routing out of the network. This value is read only and is selected by GCP. type: string - contextPath: GoogleCloudCompute.Networks.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Networks.autoCreateSubnetworks description: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. type: boolean - contextPath: GoogleCloudCompute.Networks.subnetworks description: Server-defined fully-qualified URLs for all subnetworks in this VPC network. type: string - contextPath: GoogleCloudCompute.Networks.peerings description: ' A list of network peerings for the resource.' type: string - contextPath: GoogleCloudCompute.Networks.peerings.name description: Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Networks.peerings.network description: The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. type: string - contextPath: GoogleCloudCompute.Networks.peerings.state description: State for the peering. type: string - contextPath: GoogleCloudCompute.Networks.peerings.stateDetails description: Details about the current state of the peering. type: string - contextPath: GoogleCloudCompute.Networks.peerings.autoCreateRoutes description: This field will be deprecated soon. Prefer using exchangeSubnetRoutes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. type: boolean - contextPath: GoogleCloudCompute.Networks.peerings.exchangeSubnetRoutes description: Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. type: boolean - contextPath: GoogleCloudCompute.Networks.routingConfig description: The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. type: string - contextPath: GoogleCloudCompute.Networks.routingConfig.routingMode description: The network-wide routing mode to use. If set to REGIONAL, this networks cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this networks cloud routers will advertise routes with all subnets of this network, across regions. type: string - contextPath: GoogleCloudCompute.Networks.kind description: Type of the resource. Always compute#network for networks. type: string - arguments: - description: The name of the zone for this request. name: zone required: true - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of instances contained within the specified zone. name: gcp-compute-list-instances outputs: - contextPath: GoogleCloudCompute.Instances.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Instances.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Instances.name description: The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Instances.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Instances.tags description: Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the tags.items field. type: string - contextPath: GoogleCloudCompute.Instances.tags.items description: An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Instances.tags.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the tags contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. type: string - contextPath: GoogleCloudCompute.Instances.machineType description: 'Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created.' type: string - contextPath: GoogleCloudCompute.Instances.status description: 'The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.' type: string - contextPath: GoogleCloudCompute.Instances.statusMessage description: An optional, human-readable explanation of the status. type: string - contextPath: GoogleCloudCompute.Instances.zone description: URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Instances.canIpForward description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces description: An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.network description: URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.subnetwork description: The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.networkIP description: An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.name description: ' The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs description: An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.type description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.name description: The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.natIP description: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.setPublicPtr description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.publicPtrDomainName description: The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.networkTier description: 'This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.kind description: Type of the resource. Always compute#accessConfig for access configs. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges description: An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.ipCidrRange description: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 0.0.0.0), a netmask (e.g. /24) or a CIDR format string (e.g. 0.0.0.0/24). type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.subnetworkRangeName description: Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.fingerprint description: Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.kind description: Type of the resource. Always compute#networkInterface for network interfaces. type: string - contextPath: GoogleCloudCompute.Instances.disks description: Array of disks associated with this instance. Persistent disks must be created before you can assign them. type: string - contextPath: GoogleCloudCompute.Instances.disks.type description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. type: string - contextPath: GoogleCloudCompute.Instances.disks.mode description: The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. type: string - contextPath: GoogleCloudCompute.Instances.disks.source description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.deviceName description: Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.index description: A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. type: number - contextPath: GoogleCloudCompute.Instances.disks.boot description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. type: boolean - contextPath: GoogleCloudCompute.Instances.disks.initializeParams description: Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskName description: Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImage description: The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskSizeGb description: Specifies the size of the disk in base-2 GB. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskType description: Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.kmsKeyName description: 'The name of the encryption key that is stored in Google Cloud KMS. ' type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels description: Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.key description: The disk label key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.value description: The disk label value. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.description description: An optional description. Provide this property when creating the disk. type: string - contextPath: GoogleCloudCompute.Instances.disks.autoDelete description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). type: boolean - contextPath: GoogleCloudCompute.Instances.disks.licenses description: ' Any valid publicly visible licenses.' type: string - contextPath: GoogleCloudCompute.Instances.disks.interface description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey description: Encrypts or decrypts a disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.kind description: Type of the resource. Always compute#attachedDisk for attached disks. type: string - contextPath: GoogleCloudCompute.Instances.metadata description: The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. type: string - contextPath: GoogleCloudCompute.Instances.metadata.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the metadatas contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items description: Array of key/value pairs. The total size of all keys and values must be less than 512 KB. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.key description: 'Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.' type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.value description: Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). type: string - contextPath: GoogleCloudCompute.Instances.metadata.kind description: Type of the resource. Always compute#metadata for metadata. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts description: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.email description: Email address of the service account. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.scopes description: The list of scopes to be made available for this service account. type: string - contextPath: GoogleCloudCompute.Instances.selfLink description: Server-defined URL for this resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling description: Sets the scheduling options for this instance. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.onHostMaintenance description: Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.automaticRestart description: Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.preemptible description: Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities description: A set of node affinity and anti-affinity. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.key description: Corresponds to the label key of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.operator description: Defines the operation of node selection. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.values description: Corresponds to the label values of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.cpuPlatform description: The CPU platform used by this instance. type: string - contextPath: GoogleCloudCompute.Instances.labels description: Labels to apply to this instance. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Instances.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Instances.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Instances.labelFingerprint description: A fingerprint for this request, which is essentially a hash of the labels contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. type: string - contextPath: GoogleCloudCompute.Instances.minCpuPlatform description: 'Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators description: A list of the type and count of accelerator cards attached to the instance. type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorType description: 'Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorCount description: The number of the guest accelerator cards exposed to this instance. type: string - contextPath: GoogleCloudCompute.Instances.startRestricted description: Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. type: boolean - contextPath: GoogleCloudCompute.Instances.deletionProtection description: Whether the resource should be protected against deletion. type: boolean - contextPath: GoogleCloudCompute.Instances.hostname description: Hostname. type: string - contextPath: GoogleCloudCompute.Instances.kind description: '] Type of the resource. Always compute#instance for instances.' type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves aggregated list of all of the instances in your project across all regions and zones. name: gcp-compute-aggregated-list-instances outputs: - contextPath: GoogleCloudCompute.Instances.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Instances.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Instances.name description: The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Instances.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Instances.tags description: Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the tags.items field. type: string - contextPath: GoogleCloudCompute.Instances.tags.items description: An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Instances.tags.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the tags contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. type: string - contextPath: GoogleCloudCompute.Instances.machineType description: 'Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created.' type: string - contextPath: GoogleCloudCompute.Instances.status description: 'The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.' type: string - contextPath: GoogleCloudCompute.Instances.statusMessage description: An optional, human-readable explanation of the status. type: string - contextPath: GoogleCloudCompute.Instances.zone description: URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Instances.canIpForward description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces description: An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.network description: URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.subnetwork description: The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.networkIP description: An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.name description: ' The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs description: An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.type description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.name description: The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.natIP description: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.setPublicPtr description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.publicPtrDomainName description: The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.networkTier description: 'This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.kind description: Type of the resource. Always compute#accessConfig for access configs. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges description: An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.ipCidrRange description: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 0.0.0.0), a netmask (e.g. /24) or a CIDR format string (e.g. 0.0.0.0/24). type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.subnetworkRangeName description: Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.fingerprint description: Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.kind description: Type of the resource. Always compute#networkInterface for network interfaces. type: string - contextPath: GoogleCloudCompute.Instances.disks description: Array of disks associated with this instance. Persistent disks must be created before you can assign them. type: string - contextPath: GoogleCloudCompute.Instances.disks.type description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. type: string - contextPath: GoogleCloudCompute.Instances.disks.mode description: The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. type: string - contextPath: GoogleCloudCompute.Instances.disks.source description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.deviceName description: Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.index description: A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. type: number - contextPath: GoogleCloudCompute.Instances.disks.boot description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. type: boolean - contextPath: GoogleCloudCompute.Instances.disks.initializeParams description: Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskName description: Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImage description: The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskSizeGb description: Specifies the size of the disk in base-2 GB. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskType description: Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.kmsKeyName description: 'The name of the encryption key that is stored in Google Cloud KMS. ' type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels description: Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.key description: The disk label key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.value description: The disk label value. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.description description: An optional description. Provide this property when creating the disk. type: string - contextPath: GoogleCloudCompute.Instances.disks.autoDelete description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). type: boolean - contextPath: GoogleCloudCompute.Instances.disks.licenses description: ' Any valid publicly visible licenses.' type: string - contextPath: GoogleCloudCompute.Instances.disks.interface description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey description: Encrypts or decrypts a disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.kind description: Type of the resource. Always compute#attachedDisk for attached disks. type: string - contextPath: GoogleCloudCompute.Instances.metadata description: The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. type: string - contextPath: GoogleCloudCompute.Instances.metadata.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the metadatas contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items description: Array of key/value pairs. The total size of all keys and values must be less than 512 KB. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.key description: 'Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.' type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.value description: Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). type: string - contextPath: GoogleCloudCompute.Instances.metadata.kind description: Type of the resource. Always compute#metadata for metadata. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts description: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.email description: Email address of the service account. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.scopes description: The list of scopes to be made available for this service account. type: string - contextPath: GoogleCloudCompute.Instances.selfLink description: Server-defined URL for this resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling description: Sets the scheduling options for this instance. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.onHostMaintenance description: Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.automaticRestart description: Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.preemptible description: Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities description: A set of node affinity and anti-affinity. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.key description: Corresponds to the label key of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.operator description: Defines the operation of node selection. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.values description: Corresponds to the label values of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.cpuPlatform description: The CPU platform used by this instance. type: string - contextPath: GoogleCloudCompute.Instances.labels description: Labels to apply to this instance. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Instances.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Instances.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Instances.labelFingerprint description: A fingerprint for this request, which is essentially a hash of the labels contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. type: string - contextPath: GoogleCloudCompute.Instances.minCpuPlatform description: 'Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators description: A list of the type and count of accelerator cards attached to the instance. type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorType description: 'Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorCount description: The number of the guest accelerator cards exposed to this instance. type: string - contextPath: GoogleCloudCompute.Instances.startRestricted description: Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. type: boolean - contextPath: GoogleCloudCompute.Instances.deletionProtection description: Whether the resource should be protected against deletion. type: boolean - contextPath: GoogleCloudCompute.Instances.hostname description: Hostname. type: string - contextPath: GoogleCloudCompute.Instances.kind description: '] Type of the resource. Always compute#instance for instances.' type: string - arguments: - description: Name of the Operations resource to return. name: name required: true description: Retrieves the specified Operations resource. Gets a list of operations by making a list() request. name: gcp-compute-get-global-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the Operations resource to return. name: name required: true - description: Name of the zone for this request. name: zone required: true description: Retrieves the specified zone-specific Operations resource. name: gcp-compute-get-zone-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the zone for request. name: zone required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of Operation resources contained within the specified zone. name: gcp-compute-list-zone-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the Operations resource to delete. name: name required: true - description: Name of the zone for this request. name: zone required: true description: Deletes the specified zone-specific Operations resource. name: gcp-compute-delete-zone-operation - arguments: - description: Name of the instance resource to return. name: instance required: true - description: The name of the zone for this request. name: zone required: true - description: Project ID that you want to run this command on. name: project_id description: Returns the specified Instance resource. Gets a list of available instances by making a list() request. name: gcp-compute-get-instance outputs: - contextPath: GoogleCloudCompute.Instances.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Instances.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Instances.name description: The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Instances.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Instances.tags description: Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the tags.items field. type: string - contextPath: GoogleCloudCompute.Instances.tags.items description: An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Instances.tags.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the tags contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. type: string - contextPath: GoogleCloudCompute.Instances.machineType description: 'Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created.' type: string - contextPath: GoogleCloudCompute.Instances.status description: 'The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.' type: string - contextPath: GoogleCloudCompute.Instances.statusMessage description: An optional, human-readable explanation of the status. type: string - contextPath: GoogleCloudCompute.Instances.zone description: URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Instances.canIpForward description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces description: An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.network description: URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.subnetwork description: The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.networkIP description: An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.name description: ' The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs description: An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.type description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.name description: The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.natIP description: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.setPublicPtr description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.publicPtrDomainName description: The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.networkTier description: 'This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.kind description: Type of the resource. Always compute#accessConfig for access configs. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges description: An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.ipCidrRange description: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 0.0.0.0), a netmask (e.g. /24) or a CIDR format string (e.g. 0.0.0.0/24). type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.subnetworkRangeName description: Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.fingerprint description: Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.kind description: Type of the resource. Always compute#networkInterface for network interfaces. type: string - contextPath: GoogleCloudCompute.Instances.disks description: Array of disks associated with this instance. Persistent disks must be created before you can assign them. type: string - contextPath: GoogleCloudCompute.Instances.disks.type description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. type: string - contextPath: GoogleCloudCompute.Instances.disks.mode description: The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. type: string - contextPath: GoogleCloudCompute.Instances.disks.source description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.deviceName description: Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.index description: A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. type: number - contextPath: GoogleCloudCompute.Instances.disks.boot description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. type: boolean - contextPath: GoogleCloudCompute.Instances.disks.initializeParams description: Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskName description: Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImage description: The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskSizeGb description: Specifies the size of the disk in base-2 GB. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskType description: Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.kmsKeyName description: 'The name of the encryption key that is stored in Google Cloud KMS. ' type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels description: Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.key description: The disk label key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.value description: The disk label value. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.description description: An optional description. Provide this property when creating the disk. type: string - contextPath: GoogleCloudCompute.Instances.disks.autoDelete description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). type: boolean - contextPath: GoogleCloudCompute.Instances.disks.licenses description: ' Any valid publicly visible licenses.' type: string - contextPath: GoogleCloudCompute.Instances.disks.interface description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey description: Encrypts or decrypts a disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.kind description: Type of the resource. Always compute#attachedDisk for attached disks. type: string - contextPath: GoogleCloudCompute.Instances.metadata description: The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. type: string - contextPath: GoogleCloudCompute.Instances.metadata.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the metadatas contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items description: Array of key/value pairs. The total size of all keys and values must be less than 512 KB. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.key description: 'Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.' type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.value description: Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). type: string - contextPath: GoogleCloudCompute.Instances.metadata.kind description: Type of the resource. Always compute#metadata for metadata. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts description: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.email description: Email address of the service account. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.scopes description: The list of scopes to be made available for this service account. type: string - contextPath: GoogleCloudCompute.Instances.selfLink description: Server-defined URL for this resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling description: Sets the scheduling options for this instance. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.onHostMaintenance description: Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.automaticRestart description: Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.preemptible description: Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities description: A set of node affinity and anti-affinity. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.key description: Corresponds to the label key of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.operator description: Defines the operation of node selection. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.values description: Corresponds to the label values of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.cpuPlatform description: The CPU platform used by this instance. type: string - contextPath: GoogleCloudCompute.Instances.labels description: Labels to apply to this instance. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Instances.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Instances.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Instances.labelFingerprint description: A fingerprint for this request, which is essentially a hash of the labels contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. type: string - contextPath: GoogleCloudCompute.Instances.minCpuPlatform description: 'Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators description: A list of the type and count of accelerator cards attached to the instance. type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorType description: 'Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorCount description: The number of the guest accelerator cards exposed to this instance. type: string - contextPath: GoogleCloudCompute.Instances.startRestricted description: Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. type: boolean - contextPath: GoogleCloudCompute.Instances.deletionProtection description: Whether the resource should be protected against deletion. type: boolean - contextPath: GoogleCloudCompute.Instances.hostname description: Hostname. type: string - contextPath: GoogleCloudCompute.Instances.kind description: '] Type of the resource. Always compute#instance for instances.' type: string - arguments: - description: Name of the instance resource to delete. name: instance required: true - description: The name of the zone for this request. name: zone required: true description: Deletes the specified Instance resource. For more information, see Stopping or Deleting an Instance. name: gcp-compute-delete-instance outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance resource to start. name: instance required: true - description: The name of the zone for this request. name: zone required: true description: Starts an instance that was stopped using the instances().stop method. For more information, see Restart an instance. name: gcp-compute-start-instance outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance resource to stop. name: instance required: true - description: The name of the zone for this request. name: zone description: 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. name: gcp-compute-stop-instance outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance scoping this request. name: instance required: true - description: The name of the zone for this request. name: zone required: true description: 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. name: gcp-compute-reset-instance outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance scoping this request. name: instance required: true - description: The name of the zone for this request. name: zone required: true - description: 'An object containing a list of "key": value pairs. Example: key=abc,value=123;key=ABC,value=321.' name: labels required: true - description: Fingerprint of the previous set of labels for this resource, used to prevent conflicts. Provide the latest fingerprint value when making a request to add or change labels. name: labelFingerprint required: true description: Sets labels on an instance. To learn more about labels, read the Labeling Resources documentation. name: gcp-compute-set-instance-labels outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance scoping this request. name: instance required: true - description: The name of the zone for this request. name: zone required: true - description: Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. name: metadataFingerprint - description: 'key/value pairs. EX: key=abc,value=123;key=ABC,value=321.' name: metadataItems required: true description: Sets metadata for the specified instance to the data included in the request. name: gcp-compute-set-instance-metadata outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the instance scoping this request. name: instance required: true - description: The name of the zone for this request. name: zone required: true - description: 'Full or partial URL of the machine type resource. See Machine Types for a full list of machine types. For example: zones/us-central1-f/machineTypes/n1-standard-1.' name: machineType required: true description: Changes the machine type for a stopped instance to the machine type specified in the request. name: gcp-compute-set-instance-machine-type outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the Operations resource to return. name: name required: true - description: Name of the region for this request. name: region required: true description: Retrieves the specified region-specific Operations resource. name: gcp-compute-get-region-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the region for this request. name: region required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of Operation resources contained within the specified region. name: gcp-compute-list-region-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the Operations resource to delete. name: name required: true - description: Name of the region for this request. name: region required: true description: Deletes the specified region-specific Operations resource. name: gcp-compute-delete-region-operation - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of Operation resources contained within the specified project. name: gcp-compute-list-global-operation outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the Operations resource to delete. name: name required: true description: Deletes the specified Operations resource. name: gcp-compute-delete-global-operation - arguments: - description: Name of the address resource to delete. name: address required: true - description: Name of the region for this request. name: region required: true description: Deletes the specified address resource. name: gcp-compute-delete-address outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the address resource to return. name: address required: true - description: Name of the region for this request. name: region required: true description: Returns the specified address resource. name: gcp-compute-get-address outputs: - contextPath: GoogleCloudCompute.Addresses.id description: ' The unique identifier for the resource. This identifier is defined by the server.' type: string - contextPath: GoogleCloudCompute.Addresses.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Addresses.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Addresses.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Addresses.address description: The static IP address represented by this resource. type: string - contextPath: GoogleCloudCompute.Addresses.prefixLength description: The prefix length if the resource reprensents an IP range. type: number - contextPath: GoogleCloudCompute.Addresses.status description: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. type: string - contextPath: GoogleCloudCompute.Addresses.region description: URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. type: string - contextPath: GoogleCloudCompute.Addresses.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Addresses.users description: The URLs of the resources that are using this address. type: string - contextPath: GoogleCloudCompute.Addresses.networkTier description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.' type: string - contextPath: GoogleCloudCompute.Addresses.ipVersion description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. type: string - contextPath: GoogleCloudCompute.Addresses.addressType description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. type: string - contextPath: GoogleCloudCompute.Addresses.purpose description: The purpose of resource, only used with INTERNAL type. type: string - contextPath: GoogleCloudCompute.Addresses.subnetwork description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetworks IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. type: string - contextPath: GoogleCloudCompute.Addresses.network description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. type: string - contextPath: GoogleCloudCompute.Addresses.kind description: Type of the resource. Always compute#address for addresses. type: string - arguments: - description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: Name of the region for this request. name: region required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: The static IP address represented by this resource. name: address - description: The prefix length if the resource reprensents an IP range. name: prefixLength - auto: PREDEFINED defaultValue: PREMIUM description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM.' name: networkTier predefined: - PREMIUM - STANDARD - auto: PREDEFINED defaultValue: EXTERNAL description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. name: addressType predefined: - EXTERNAL - INTERNAL - description: The purpose of resource, only used with INTERNAL type. name: purpose - description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. name: subnetwork - description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. name: network description: Creates an address resource in the specified project using the data included in the request. name: gcp-compute-insert-address outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the region for this request. name: region required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of addresses contained within the specified region. name: gcp-compute-list-addresses outputs: - contextPath: GoogleCloudCompute.Addresses.id description: ' The unique identifier for the resource. This identifier is defined by the server.' type: string - contextPath: GoogleCloudCompute.Addresses.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Addresses.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Addresses.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Addresses.address description: The static IP address represented by this resource. type: string - contextPath: GoogleCloudCompute.Addresses.prefixLength description: The prefix length if the resource reprensents an IP range. type: number - contextPath: GoogleCloudCompute.Addresses.status description: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. type: string - contextPath: GoogleCloudCompute.Addresses.region description: URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. type: string - contextPath: GoogleCloudCompute.Addresses.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Addresses.users description: The URLs of the resources that are using this address. type: string - contextPath: GoogleCloudCompute.Addresses.networkTier description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.' type: string - contextPath: GoogleCloudCompute.Addresses.ipVersion description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. type: string - contextPath: GoogleCloudCompute.Addresses.addressType description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. type: string - contextPath: GoogleCloudCompute.Addresses.purpose description: The purpose of resource, only used with INTERNAL type. type: string - contextPath: GoogleCloudCompute.Addresses.subnetwork description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetworks IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. type: string - contextPath: GoogleCloudCompute.Addresses.network description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. type: string - contextPath: GoogleCloudCompute.Addresses.kind description: Type of the resource. Always compute#address for addresses. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves an aggregated list of addresses. name: gcp-compute-aggregated-list-addresses outputs: - contextPath: GoogleCloudCompute.Addresses.id description: ' The unique identifier for the resource. This identifier is defined by the server.' type: string - contextPath: GoogleCloudCompute.Addresses.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Addresses.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Addresses.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Addresses.address description: The static IP address represented by this resource. type: string - contextPath: GoogleCloudCompute.Addresses.prefixLength description: The prefix length if the resource reprensents an IP range. type: number - contextPath: GoogleCloudCompute.Addresses.status description: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. type: string - contextPath: GoogleCloudCompute.Addresses.region description: URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. type: string - contextPath: GoogleCloudCompute.Addresses.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Addresses.users description: The URLs of the resources that are using this address. type: string - contextPath: GoogleCloudCompute.Addresses.networkTier description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.' type: string - contextPath: GoogleCloudCompute.Addresses.ipVersion description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. type: string - contextPath: GoogleCloudCompute.Addresses.addressType description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. type: string - contextPath: GoogleCloudCompute.Addresses.purpose description: The purpose of resource, only used with INTERNAL type. type: string - contextPath: GoogleCloudCompute.Addresses.subnetwork description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetworks IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. type: string - contextPath: GoogleCloudCompute.Addresses.network description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. type: string - contextPath: GoogleCloudCompute.Addresses.kind description: Type of the resource. Always compute#address for addresses. type: string - arguments: - description: Name of the address resource to delete. name: address required: true description: Deletes the specified address resource. name: gcp-compute-delete-global-address outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the address resource to delete. name: address required: true description: Deletes the specified address resource. name: gcp-compute-get-global-address outputs: - contextPath: GoogleCloudCompute.Addresses.id description: ' The unique identifier for the resource. This identifier is defined by the server.' type: string - contextPath: GoogleCloudCompute.Addresses.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Addresses.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Addresses.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Addresses.address description: The static IP address represented by this resource. type: string - contextPath: GoogleCloudCompute.Addresses.prefixLength description: The prefix length if the resource reprensents an IP range. type: number - contextPath: GoogleCloudCompute.Addresses.status description: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. type: string - contextPath: GoogleCloudCompute.Addresses.region description: URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. type: string - contextPath: GoogleCloudCompute.Addresses.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Addresses.users description: The URLs of the resources that are using this address. type: string - contextPath: GoogleCloudCompute.Addresses.networkTier description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.' type: string - contextPath: GoogleCloudCompute.Addresses.ipVersion description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. type: string - contextPath: GoogleCloudCompute.Addresses.addressType description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. type: string - contextPath: GoogleCloudCompute.Addresses.purpose description: The purpose of resource, only used with INTERNAL type. type: string - contextPath: GoogleCloudCompute.Addresses.subnetwork description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetworks IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. type: string - contextPath: GoogleCloudCompute.Addresses.network description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. type: string - contextPath: GoogleCloudCompute.Addresses.kind description: Type of the resource. Always compute#address for addresses. type: string - arguments: - description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: The static IP address represented by this resource. name: address - description: The prefix length if the resource reprensents an IP range. name: prefixLength - auto: PREDEFINED defaultValue: PREMIUM description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM.' name: networkTier predefined: - PREMIUM - STANDARD - auto: PREDEFINED description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. name: ipVersion predefined: - IPV4 - IPV6 required: true - auto: PREDEFINED defaultValue: EXTERNAL description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. name: addressType predefined: - EXTERNAL - INTERNAL - description: The purpose of resource, only used with INTERNAL type. name: purpose - description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. name: subnetwork - description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. name: network description: Creates an address resource in the specified project using the data included in the request. name: gcp-compute-insert-global-address outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of global addresses. name: gcp-compute-list-global-addresses outputs: - contextPath: GoogleCloudCompute.Addresses.id description: ' The unique identifier for the resource. This identifier is defined by the server.' type: string - contextPath: GoogleCloudCompute.Addresses.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Addresses.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Addresses.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Addresses.address description: The static IP address represented by this resource. type: string - contextPath: GoogleCloudCompute.Addresses.prefixLength description: The prefix length if the resource reprensents an IP range. type: number - contextPath: GoogleCloudCompute.Addresses.status description: The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. type: string - contextPath: GoogleCloudCompute.Addresses.region description: URL of the region where the regional address resides. This field is not applicable to global addresses. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. type: string - contextPath: GoogleCloudCompute.Addresses.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Addresses.users description: The URLs of the resources that are using this address. type: string - contextPath: GoogleCloudCompute.Addresses.networkTier description: 'This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer.' type: string - contextPath: GoogleCloudCompute.Addresses.ipVersion description: The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. type: string - contextPath: GoogleCloudCompute.Addresses.addressType description: The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. type: string - contextPath: GoogleCloudCompute.Addresses.purpose description: The purpose of resource, only used with INTERNAL type. type: string - contextPath: GoogleCloudCompute.Addresses.subnetwork description: The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetworks IP range. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. type: string - contextPath: GoogleCloudCompute.Addresses.network description: The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. type: string - contextPath: GoogleCloudCompute.Addresses.kind description: Type of the resource. Always compute#address for addresses. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves an aggregated list of persistent disks. name: gcp-compute-aggregated-list-disks outputs: - contextPath: GoogleCloudCompute.Disks.id description: Unique identifier for the resource; defined by the server. type: string - contextPath: GoogleCloudCompute.Disks.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Disks.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Disks.sizeGb description: Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. type: string - contextPath: GoogleCloudCompute.Disks.zone description: URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.status description: The status of disk creation. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshot description: The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotId description: The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. type: string - contextPath: GoogleCloudCompute.Disks.options description: Internal use only. type: string - contextPath: GoogleCloudCompute.Disks.selfLink description: Server-defined fully-qualified URL for this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImage description: The source image used to create this disk. If the source image is deleted, this field will not be set. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageId description: The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. type: string - contextPath: GoogleCloudCompute.Disks.type description: 'URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd.' type: string - contextPath: GoogleCloudCompute.Disks.licenses description: A list of publicly visible licenses. Reserved for Googles use. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.lastAttachTimestamp description: Last attach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.lastDetachTimestamp description: Last detach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.users description: 'Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance.' type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey description: Encrypts the disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.sha256 description: 'The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.labels description: Labels to apply to this disk. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Disks.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Disks.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Disks.labelFingerprint description: A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Disks.region description: URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.replicaZones description: URLs of the zones where the disk should be replicated to. Only applicable for regional resources. type: string - contextPath: GoogleCloudCompute.Disks.licenseCodes description: Integer license codes indicating which licenses are attached to this disk. type: string - contextPath: GoogleCloudCompute.Disks.physicalBlockSizeBytes description: Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the callers project. type: string - contextPath: GoogleCloudCompute.Disks.kind description: Type of the resource. Always compute#disk for disks. type: string - arguments: - description: The name of the zone for this request. name: zone required: true - description: Name of the snapshot. name: name required: true - description: Name of the persistent disk to snapshot. name: disk required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: snapshotEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: snapshotEncryptionKeyKmsKeyName - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceDiskEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceDiskEncryptionKeyKmsKeyName - description: Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. ex key=abc,value=123;key=abc,value=123. name: labels - description: A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. name: labelFingerprint description: Creates a snapshot of a specified persistent disk. name: gcp-compute-create-disk-snapshot outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the persistent disk to delete. name: disk required: true - description: The name of the zone for this request. name: zone required: true description: 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. name: gcp-compute-delete-disk outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the persistent disk to return. name: disk required: true - description: The name of the zone for this request. name: zone required: true description: Returns a specified persistent disk. Gets a list of available persistent disks by making a list() request. name: gcp-compute-get-disk outputs: - contextPath: GoogleCloudCompute.Disks.id description: Unique identifier for the resource; defined by the server. type: string - contextPath: GoogleCloudCompute.Disks.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Disks.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Disks.sizeGb description: Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. type: string - contextPath: GoogleCloudCompute.Disks.zone description: URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.status description: The status of disk creation. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshot description: The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotId description: The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. type: string - contextPath: GoogleCloudCompute.Disks.options description: Internal use only. type: string - contextPath: GoogleCloudCompute.Disks.selfLink description: Server-defined fully-qualified URL for this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImage description: The source image used to create this disk. If the source image is deleted, this field will not be set. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageId description: The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. type: string - contextPath: GoogleCloudCompute.Disks.type description: 'URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd.' type: string - contextPath: GoogleCloudCompute.Disks.licenses description: A list of publicly visible licenses. Reserved for Googles use. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.lastAttachTimestamp description: Last attach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.lastDetachTimestamp description: Last detach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.users description: 'Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance.' type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey description: Encrypts the disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.sha256 description: 'The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.labels description: Labels to apply to this disk. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Disks.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Disks.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Disks.labelFingerprint description: A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Disks.region description: URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.replicaZones description: URLs of the zones where the disk should be replicated to. Only applicable for regional resources. type: string - contextPath: GoogleCloudCompute.Disks.licenseCodes description: Integer license codes indicating which licenses are attached to this disk. type: string - contextPath: GoogleCloudCompute.Disks.physicalBlockSizeBytes description: Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the callers project. type: string - contextPath: GoogleCloudCompute.Disks.kind description: Type of the resource. Always compute#disk for disks. type: string - arguments: - description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: The name of the zone for this request. name: zone required: true - description: 'URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd.' name: disktype required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. name: sizeGb required: true - description: The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. name: sourceSnapshot - description: The source image used to create this disk. If the source image is deleted, this field will not be set. name: sourceImage - description: A list of publicly visible licenses. Reserved for Google's use. name: licenses - description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Separated with ,. name: guestOsFeatures - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: diskEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: diskEncryptionKeyKmsKeyName - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceImageEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceImageEncryptionKeyKmsKeyName - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceSnapshotEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceSnapshotEncryptionKeyKmsKeyName - description: 'Labels to apply to this disk. These can be later modified by the setLabels method. ex: key=abc,value=123;key=abc,value=123.' name: labels - description: A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. name: labelFingerprint - description: URLs of the zones where the disk should be replicated to. Only applicable for regional resources. name: replicaZones - description: Integer license codes indicating which licenses are attached to this disk. name: licenseCodes - description: Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. name: physicalBlockSizeBytes description: Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, 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. name: gcp-compute-insert-disk outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: The name of the zone for this request. name: zone required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of persistent disks contained within the specified zone. name: gcp-compute-list-disks outputs: - contextPath: GoogleCloudCompute.Disks.id description: Unique identifier for the resource; defined by the server. type: string - contextPath: GoogleCloudCompute.Disks.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Disks.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Disks.sizeGb description: Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. type: string - contextPath: GoogleCloudCompute.Disks.zone description: URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.status description: The status of disk creation. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshot description: The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotId description: The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. type: string - contextPath: GoogleCloudCompute.Disks.options description: Internal use only. type: string - contextPath: GoogleCloudCompute.Disks.selfLink description: Server-defined fully-qualified URL for this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImage description: The source image used to create this disk. If the source image is deleted, this field will not be set. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageId description: The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. type: string - contextPath: GoogleCloudCompute.Disks.type description: 'URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd.' type: string - contextPath: GoogleCloudCompute.Disks.licenses description: A list of publicly visible licenses. Reserved for Googles use. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Disks.lastAttachTimestamp description: Last attach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.lastDetachTimestamp description: Last detach timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Disks.users description: 'Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance.' type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey description: Encrypts the disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.sha256 description: 'The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Disks.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Disks.labels description: Labels to apply to this disk. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Disks.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Disks.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Disks.labelFingerprint description: A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Disks.region description: URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Disks.replicaZones description: URLs of the zones where the disk should be replicated to. Only applicable for regional resources. type: string - contextPath: GoogleCloudCompute.Disks.licenseCodes description: Integer license codes indicating which licenses are attached to this disk. type: string - contextPath: GoogleCloudCompute.Disks.physicalBlockSizeBytes description: Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. Currently supported sizes are 4096 and 16384, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the callers project. type: string - contextPath: GoogleCloudCompute.Disks.kind description: Type of the resource. Always compute#disk for disks. type: string - arguments: - description: The name of the persistent disk. name: disk required: true - description: The name of the zone for this request. name: zone required: true - description: The new size of the persistent disk, which is specified in GB. name: sizeGb required: true description: Resizes the specified persistent disk. You can only increase the size of the disk. name: gcp-compute-resize-disk outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name or id of the resource for this request. name: disk required: true - description: The name of the zone for this request. name: zone required: true - description: 'The labels to set for this resource. An object containing a list of "key": value pairs. Example: key=abc,value=123;key=abc,value=123.' name: labels required: true - description: The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. Make a get() request to the resource to get the latest fingerprint. name: labelFingerprint description: Sets the labels on a disk. name: gcp-compute-set-disk-labels outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves an aggregated list of disk types. name: gcp-compute-aggregated-list-disk-types outputs: - contextPath: GoogleCloudCompute.DiskTypes.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.DiskTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.DiskTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.description description: ' An optional description of this resource.' type: string - contextPath: GoogleCloudCompute.DiskTypes.validDiskSize description: An optional textual description of the valid disk size, such as "10GB-10TB". type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated description: The deprecation status associated with this disk type. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.zone description: URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.defaultDiskSizeGb description: Server-defined default disk size in GB. type: string - contextPath: GoogleCloudCompute.DiskTypes.region description: URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.kind description: Type of the resource. Always compute#diskType for disk types. type: string - arguments: - description: Name of the disk type to return. name: disktype required: true - description: The name of the zone for this request. name: zone required: true description: Returns the specified disk type. Gets a list of available disk types by making a list() request. name: gcp-compute-get-disk-type outputs: - contextPath: GoogleCloudCompute.DiskTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.DiskTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.description description: ' An optional description of this resource.' type: string - contextPath: GoogleCloudCompute.DiskTypes.validDiskSize description: An optional textual description of the valid disk size, such as "10GB-10TB". type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated description: The deprecation status associated with this disk type. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.zone description: URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.defaultDiskSizeGb description: Server-defined default disk size in GB. type: string - contextPath: GoogleCloudCompute.DiskTypes.region description: URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.kind description: Type of the resource. Always compute#diskType for disk types. type: string - contextPath: GoogleCloudCompute.DiskTypes.id description: The unique identifier for the resource. type: string - arguments: - description: The name of the zone for this request. name: zone required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of disk types available to the specified project. name: gcp-compute-list-disk-types outputs: - contextPath: GoogleCloudCompute.DiskTypes.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.DiskTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.DiskTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.description description: ' An optional description of this resource.' type: string - contextPath: GoogleCloudCompute.DiskTypes.validDiskSize description: An optional textual description of the valid disk size, such as "10GB-10TB". type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated description: The deprecation status associated with this disk type. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.DiskTypes.zone description: URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.DiskTypes.defaultDiskSizeGb description: Server-defined default disk size in GB. type: string - contextPath: GoogleCloudCompute.DiskTypes.region description: URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.DiskTypes.kind description: Type of the resource. Always compute#diskType for disk types. type: string - arguments: - description: Project ID for this request. if left empty configured project will be used. name: project - description: Name of the image resource to return. name: image required: true description: Returns the specified image. Gets a list of available images by making a list() request. name: gcp-compute-get-image outputs: - contextPath: GoogleCloudCompute.Images.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Images.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Images.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Images.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Images.sourceType description: The type of the image used to create this disk. The default and only value is RAW. type: string - contextPath: GoogleCloudCompute.Images.rawDisk description: The parameters of the raw disk image. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.source description: The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.sha1Checksum description: An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.containerType description: The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.deprecated description: The deprecation status associated with this image. type: string - contextPath: GoogleCloudCompute.Images.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Images.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.status description: The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. type: string - contextPath: GoogleCloudCompute.Images.archiveSizeBytes description: Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). type: string - contextPath: GoogleCloudCompute.Images.diskSizeGb description: Size of the image when restored onto a persistent disk (in GB). type: string - contextPath: GoogleCloudCompute.Images.sourceDisk description: 'URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk , projects/project/zones/zone/disks/disk , zones/zone/disks/disk.' type: string - contextPath: GoogleCloudCompute.Images.sourceDiskId description: The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. type: string - contextPath: GoogleCloudCompute.Images.licenses description: Any applicable license URI. type: string - contextPath: GoogleCloudCompute.Images.family description: The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey description: Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Images.labels description: Labels to apply to this image. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Images.labelFingerprint description: A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.licenseCodes description: Integer license codes indicating which licenses are attached to this image. type: string - contextPath: GoogleCloudCompute.Images.sourceImage description: URL of the source image used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceImageId description: The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.sha256 description: ' The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshot description: URL of the source snapshot used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotId description: ' The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.kind description: Type of the resource. Always compute#image for images. type: string - arguments: - description: Project ID for this request. if left empty configured project will be used. name: project - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. name: gcp-compute-list-images outputs: - contextPath: GoogleCloudCompute.Images.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Images.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Images.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Images.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Images.sourceType description: The type of the image used to create this disk. The default and only value is RAW. type: string - contextPath: GoogleCloudCompute.Images.rawDisk description: The parameters of the raw disk image. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.source description: The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.sha1Checksum description: An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.rawDisk.containerType description: The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. type: string - contextPath: GoogleCloudCompute.Images.deprecated description: The deprecation status associated with this image. type: string - contextPath: GoogleCloudCompute.Images.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Images.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Images.status description: The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. type: string - contextPath: GoogleCloudCompute.Images.archiveSizeBytes description: Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). type: string - contextPath: GoogleCloudCompute.Images.diskSizeGb description: Size of the image when restored onto a persistent disk (in GB). type: string - contextPath: GoogleCloudCompute.Images.sourceDisk description: 'URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk , projects/project/zones/zone/disks/disk , zones/zone/disks/disk.' type: string - contextPath: GoogleCloudCompute.Images.sourceDiskId description: The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. type: string - contextPath: GoogleCloudCompute.Images.licenses description: Any applicable license URI. type: string - contextPath: GoogleCloudCompute.Images.family description: The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey description: Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.imageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceDiskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Images.labels description: Labels to apply to this image. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Images.labelFingerprint description: A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Images.licenseCodes description: Integer license codes indicating which licenses are attached to this image. type: string - contextPath: GoogleCloudCompute.Images.sourceImage description: URL of the source image used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceImageId description: The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceImageEncryptionKey.sha256 description: ' The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshot description: URL of the source snapshot used to create this image. This can be a full or valid partial URL. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotId description: ' The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name.' type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey description: The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Images.sourceSnapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Images.kind description: Type of the resource. Always compute#image for images. type: string - arguments: - description: Name of the image resource to delete. name: image required: true description: Deletes the specified image. name: gcp-compute-delete-image outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name or id of the resource for this request. name: image required: true - description: 'An object containing a list of "key": value pairs. Example: key=abc,value=123;key=abc,value=123.' name: labels required: true - description: The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. name: labelFingerprint required: true description: Sets the labels on an image. name: gcp-compute-set-image-labels outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both. name: rawDiskSource - description: An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created. name: rawDiskSha1Checksum - description: The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created. name: rawDiskContainerType - auto: PREDEFINED description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. name: deprecatedState predefined: - ACTIVE - DEPRECATED - OBSOLETE - DELETED - description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. name: deprecatedReplacement - description: Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). name: archiveSizeBytes - description: Size of the image when restored onto a persistent disk (in GB). name: diskSizeGb - description: 'URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values: https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk projects/project/zones/zone/disks/disk zones/zone/disks/disk Authorization requires the following Google IAM permission on the specified resource sourceDisk: compute.disks.useReadOnly' name: sourceDisk - description: 'Any applicable license URI. Authorization requires the following Google IAM permission on the specified resource licenses: compute.licenseCodes.use' name: licenses - description: The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. name: family - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: imageEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: imageEncryptionKeyKmsKeyName - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceDiskEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceDiskEncryptionKeyKmsKeyName - description: 'Labels to apply to this image. These can be later modified by the setLabels method. An object containing a list of "key": value pairs. Example: key=abc,value=123;key=abc,value=123.' name: labels - description: A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. name: labelFingerprint - description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. name: guestOsFeatures - description: 'Integer license codes indicating which licenses are attached to this image. Authorization requires the following Google IAM permission on the specified resource licenseCodes: compute.licenseCodes.use' name: licenseCodes - description: 'URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: this property, or the rawDisk.source property, or the sourceDisk property in order to create an image.' name: sourceImage - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceImageEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceImageEncryptionKeyKmsKeyName - description: 'URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: this property, or the sourceImage property, or the rawDisk.source property, or the sourceDisk property in order to create an image.' name: sourceSnapshot - description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. name: sourceSnapshotEncryptionKeyRawKey - description: The name of the encryption key that is stored in Google Cloud KMS. name: sourceSnapshotEncryptionKeyKmsKeyName - auto: PREDEFINED description: Force image creation if true. name: forceCreate predefined: - 'true' - 'false' required: true description: Creates an image in the specified project using the data included in the request. name: gcp-compute-insert-image outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: The name of the instance group where you are adding instances. name: instanceGroup required: true - description: The name of the zone where the instance group is located. name: zone required: true - description: The list of instances to add to the instance group. comma separated. name: instances required: true description: 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. name: gcp-compute-instance-groups-add-instances outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of instance groups and sorts them by zone. name: gcp-compute-aggregated-list-instance-groups - arguments: - description: The name of the instance group to delete. name: instanceGroup required: true - description: The name of the zone where the instance group is located. name: zone required: true description: 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. HTTP. name: gcp-compute-delete-instance-group outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: The name of the instance group. name: instanceGroup required: true - description: The name of the zone where the instance group is located. name: zone required: true description: Returns the specified instance group. Gets a list of available instance groups by making a list() request. name: gcp-compute-get-instance-group outputs: - contextPath: GoogleCloudCompute.InstanceGroups.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.InstanceGroups.creationTimestamp description: The creation timestamp for this instance group in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.InstanceGroups.name description: The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.InstanceGroups.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts description: Assigns a name to a port number. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts.name description: The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts.port description: The port number, which can be a value between 1 and 65535. type: string - contextPath: GoogleCloudCompute.InstanceGroups.network description: The URL of the network to which all instances in the instance group belong. type: string - contextPath: GoogleCloudCompute.InstanceGroups.fingerprint description: The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. type: string - contextPath: GoogleCloudCompute.InstanceGroups.zone description: The URL of the zone where the instance group is located (for zonal resources). type: string - contextPath: GoogleCloudCompute.InstanceGroups.selfLink description: The URL for this instance group. The server generates this URL. type: string - contextPath: GoogleCloudCompute.InstanceGroups.size description: The total number of instances in the instance group. type: string - contextPath: GoogleCloudCompute.InstanceGroups.region description: The URL of the region where the instance group is located (for regional resources). type: string - contextPath: GoogleCloudCompute.InstanceGroups.subnetwork description: The URL of the subnetwork to which all instances in the instance group belong. type: string - contextPath: GoogleCloudCompute.InstanceGroups.kind description: ' The resource type, which is always compute#instanceGroup for instance groups.' type: string - arguments: - description: The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. name: name required: true - description: The name of the zone where you want to create the instance group. name: zone required: true - description: 'Assigns a name to a port number. For example: name=abc,port=123;name=abc,port=123.' name: namedPorts - description: The URL of the network to which all instances in the instance group belong. name: network description: Creates an instance group in the specified project using the parameters that are included in the request. name: gcp-compute-insert-instance-group outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: The name of the zone where the instance group is located. name: zone required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of instance groups that are located in the specified project and zone. name: gcp-compute-list-instance-groups outputs: - contextPath: GoogleCloudCompute.InstanceGroups.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.InstanceGroups.creationTimestamp description: The creation timestamp for this instance group in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.InstanceGroups.name description: The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.InstanceGroups.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts description: Assigns a name to a port number. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts.name description: The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.InstanceGroups.namedPorts.port description: The port number, which can be a value between 1 and 65535. type: string - contextPath: GoogleCloudCompute.InstanceGroups.network description: The URL of the network to which all instances in the instance group belong. type: string - contextPath: GoogleCloudCompute.InstanceGroups.fingerprint description: The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. type: string - contextPath: GoogleCloudCompute.InstanceGroups.zone description: The URL of the zone where the instance group is located (for zonal resources). type: string - contextPath: GoogleCloudCompute.InstanceGroups.selfLink description: The URL for this instance group. The server generates this URL. type: string - contextPath: GoogleCloudCompute.InstanceGroups.size description: The total number of instances in the instance group. type: string - contextPath: GoogleCloudCompute.InstanceGroups.region description: The URL of the region where the instance group is located (for regional resources). type: string - contextPath: GoogleCloudCompute.InstanceGroups.subnetwork description: The URL of the subnetwork to which all instances in the instance group belong. type: string - contextPath: GoogleCloudCompute.InstanceGroups.kind description: ' The resource type, which is always compute#instanceGroup for instance groups.' type: string - arguments: - description: The name of the zone where the instance group is located. name: zone required: true - description: The name of the instance group from which you want to generate a list of included instances. name: instanceGroup required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken - auto: PREDEFINED description: A filter for the state of the instances in the instance group. Valid options are ALL or RUNNING. If you do not specify this parameter the list includes all instances regardless of their state. name: instanceState predefined: - ALL - RUNNING description: Lists the instances in the specified instance group. name: gcp-compute-list-instance-group-instances outputs: - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Instances.instance description: The URL of the instance. type: string - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Instances.status description: The status of the instance. type: string - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Instances.namedPorts description: ' The named ports that belong to this instance group.' type: string - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Instances.namedPorts.name description: The name for this named port. The name must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Instances.namedPorts.port description: The port number, which can be a value between 1 and 65535. type: string - contextPath: GoogleCloudCompute.InstanceGroupsInstances.Group description: The group listed. type: Unknown - arguments: - description: The name of the instance group where the specified instances will be removed. name: instanceGroup required: true - description: The name of the zone where the instance group is located. name: zone required: true - description: The list of instances to remove from the instance group. comma separated. name: instances required: true description: 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. name: gcp-compute-instance-groups-remove-instances outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: The name of the instance group where the named ports are updated. name: instanceGroup required: true - description: The name of the zone where the instance group is located. name: zone required: true - description: 'The list of named ports to set for this instance group. example: name=abc,port=123;name=abc,port=123.' name: namedPorts required: true - description: The fingerprint of the named ports information for this instance group. Use this optional property to prevent conflicts when multiple users change the named ports settings concurrently. Obtain the fingerprint with the instanceGroups.get method. Then, include the fingerprint in your request to ensure that you do not overwrite changes that were applied from another concurrent request. A request with an incorrect fingerprint will fail with error 412 conditionNotMet. name: fingerprint description: Sets the named ports for the specified instance group. name: gcp-compute-set-group-instance-named-ports outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the region resource to return. name: region required: true description: Returns the specified Region resource. Gets a list of available regions by making a list() request. name: gcp-compute-get-region outputs: - contextPath: GoogleCloudCompute.Regions.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Regions.creationTimestamp description: ' Creation timestamp in RFC3339 text format.' type: string - contextPath: GoogleCloudCompute.Regions.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Regions.description description: Textual description of the resource. type: string - contextPath: GoogleCloudCompute.Regions.status description: Status of the region, either UP or DOWN. type: string - contextPath: GoogleCloudCompute.Regions.zones description: A list of zones available in this region, in the form of resource URLs. type: string - contextPath: GoogleCloudCompute.Regions.quotas description: Quotas assigned to this region. type: string - contextPath: GoogleCloudCompute.Regions.quotas.metric description: Name of the quota metric. type: string - contextPath: GoogleCloudCompute.Regions.quotas.limit description: Quota limit for this metric. type: string - contextPath: GoogleCloudCompute.Regions.quotas.usage description: ' Current usage of this metric.' type: string - contextPath: GoogleCloudCompute.Regions.quotas.owner description: Owning resource. This is the resource on which this quota is applied. type: string - contextPath: GoogleCloudCompute.Regions.deprecated description: The deprecation status associated with this region. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Regions.kind description: Type of the resource. Always compute#region for regions. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of region resources available to the specified project. name: gcp-compute-list-regions outputs: - contextPath: GoogleCloudCompute.Regions.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Regions.creationTimestamp description: ' Creation timestamp in RFC3339 text format.' type: string - contextPath: GoogleCloudCompute.Regions.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Regions.description description: Textual description of the resource. type: string - contextPath: GoogleCloudCompute.Regions.status description: Status of the region, either UP or DOWN. type: string - contextPath: GoogleCloudCompute.Regions.zones description: A list of zones available in this region, in the form of resource URLs. type: string - contextPath: GoogleCloudCompute.Regions.quotas description: Quotas assigned to this region. type: string - contextPath: GoogleCloudCompute.Regions.quotas.metric description: Name of the quota metric. type: string - contextPath: GoogleCloudCompute.Regions.quotas.limit description: Quota limit for this metric. type: string - contextPath: GoogleCloudCompute.Regions.quotas.usage description: ' Current usage of this metric.' type: string - contextPath: GoogleCloudCompute.Regions.quotas.owner description: Owning resource. This is the resource on which this quota is applied. type: string - contextPath: GoogleCloudCompute.Regions.deprecated description: The deprecation status associated with this region. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Regions.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Regions.kind description: Type of the resource. Always compute#region for regions. type: string - arguments: - description: Name of the zone resource to return. name: zone required: true description: Returns the specified Zone resource. Gets a list of available zones by making a list() request. name: gcp-compute-get-zone outputs: - contextPath: GoogleCloudCompute.Zones.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Zones.creationTimestamp description: ' Creation timestamp in RFC3339 text format.' type: string - contextPath: GoogleCloudCompute.Zones.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Zones.description description: Textual description of the resource. type: string - contextPath: GoogleCloudCompute.Zones.status description: Status of the zone, either UP or DOWN. type: string - contextPath: GoogleCloudCompute.Zones.deprecated description: The deprecation status associated with this zone. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.region description: Full URL reference to the region which hosts the zone. type: string - contextPath: GoogleCloudCompute.Zones.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Zones.availableCpuPlatforms description: Available cpu/platform selections for the zone. Do not use field = 7 or field = 11. Next available field = 14. type: string - contextPath: GoogleCloudCompute.Zones.kind description: Type of the resource. Always compute#zone for zones. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of Zone resources available to the specified project. name: gcp-compute-list-zones outputs: - contextPath: GoogleCloudCompute.Zones.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Zones.creationTimestamp description: ' Creation timestamp in RFC3339 text format.' type: string - contextPath: GoogleCloudCompute.Zones.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Zones.description description: Textual description of the resource. type: string - contextPath: GoogleCloudCompute.Zones.status description: Status of the zone, either UP or DOWN. type: string - contextPath: GoogleCloudCompute.Zones.deprecated description: The deprecation status associated with this zone. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.Zones.region description: Full URL reference to the region which hosts the zone. type: string - contextPath: GoogleCloudCompute.Zones.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Zones.availableCpuPlatforms description: Available cpu/platform selections for the zone. Do not use field = 7 or field = 11. Next available field = 14. type: string - contextPath: GoogleCloudCompute.Zones.kind description: Type of the resource. Always compute#zone for zones. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves an aggregated list of machine types. name: gcp-compute-aggregated-list-machine-types outputs: - contextPath: GoogleCloudCompute.MachineTypes.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.MachineTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.MachineTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.description description: An optional textual description of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.guestCpus description: The number of virtual CPUs that are available to the instance. type: number - contextPath: GoogleCloudCompute.MachineTypes.memoryMb description: The amount of physical memory available to the instance, defined in MB. type: number - contextPath: GoogleCloudCompute.MachineTypes.imageSpaceGb description: This property is deprecated and will never be populated with any relevant values. type: number - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks description: A list of extended scratch disks assigned to the instance. type: string - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks.diskGb description: Size of the scratch disk, defined in GB. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisks description: Maximum persistent disks allowed. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisksSizeGb description: ' Maximum total persistent disks size (GB) allowed.' type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated description: The deprecation status associated with this machine type. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.zone description: The name of the zone where the machine type resides, such as us-central1-a. type: string - contextPath: GoogleCloudCompute.MachineTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.isSharedCpu description: Whether this machine type has a shared CPU. See Shared-core machine types for more information. type: boolean - contextPath: GoogleCloudCompute.MachineTypes.kind description: The type of the resource. Always compute#machineType for machine types. type: string - arguments: - description: Name of the machine type to return. name: machineType required: true - description: The name of the zone for this request. name: zone required: true description: Returns the specified machine type. Gets a list of available machine types by making a list() request. name: gcp-compute-get-machine-type outputs: - contextPath: GoogleCloudCompute.MachineTypes.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.MachineTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.MachineTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.description description: An optional textual description of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.guestCpus description: The number of virtual CPUs that are available to the instance. type: number - contextPath: GoogleCloudCompute.MachineTypes.memoryMb description: The amount of physical memory available to the instance, defined in MB. type: number - contextPath: GoogleCloudCompute.MachineTypes.imageSpaceGb description: This property is deprecated and will never be populated with any relevant values. type: number - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks description: A list of extended scratch disks assigned to the instance. type: string - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks.diskGb description: Size of the scratch disk, defined in GB. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisks description: Maximum persistent disks allowed. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisksSizeGb description: ' Maximum total persistent disks size (GB) allowed.' type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated description: The deprecation status associated with this machine type. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.zone description: The name of the zone where the machine type resides, such as us-central1-a. type: string - contextPath: GoogleCloudCompute.MachineTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.isSharedCpu description: Whether this machine type has a shared CPU. See Shared-core machine types for more information. type: boolean - contextPath: GoogleCloudCompute.MachineTypes.kind description: The type of the resource. Always compute#machineType for machine types. type: string - arguments: - description: The name of the zone for this request. name: zone required: true - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves a list of machine types available to the specified project. name: gcp-compute-list-machine-types outputs: - contextPath: GoogleCloudCompute.MachineTypes.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.MachineTypes.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.MachineTypes.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.description description: An optional textual description of the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.guestCpus description: The number of virtual CPUs that are available to the instance. type: number - contextPath: GoogleCloudCompute.MachineTypes.memoryMb description: The amount of physical memory available to the instance, defined in MB. type: number - contextPath: GoogleCloudCompute.MachineTypes.imageSpaceGb description: This property is deprecated and will never be populated with any relevant values. type: number - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks description: A list of extended scratch disks assigned to the instance. type: string - contextPath: GoogleCloudCompute.MachineTypes.scratchDisks.diskGb description: Size of the scratch disk, defined in GB. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisks description: Maximum persistent disks allowed. type: number - contextPath: GoogleCloudCompute.MachineTypes.maximumPersistentDisksSizeGb description: ' Maximum total persistent disks size (GB) allowed.' type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated description: The deprecation status associated with this machine type. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.state description: The deprecation state of this resource. This can be ACTIVE DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.replacement description: The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deprecated description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.obsolete description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.deprecated.deleted description: An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. type: string - contextPath: GoogleCloudCompute.MachineTypes.zone description: The name of the zone where the machine type resides, such as us-central1-a. type: string - contextPath: GoogleCloudCompute.MachineTypes.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.MachineTypes.isSharedCpu description: Whether this machine type has a shared CPU. See Shared-core machine types for more information. type: boolean - contextPath: GoogleCloudCompute.MachineTypes.kind description: The type of the resource. Always compute#machineType for machine types. type: string - arguments: - description: Name of the network resource to add peering to. name: network required: true - description: ' Name of the peering, which should conform to RFC1035.' name: name - description: URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. name: peerNetwork - description: Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: networkPeeringName - description: The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. name: networkPeeringNetwork - auto: PREDEFINED description: Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. name: networkPeeringExchangeSubnetRoutes predefined: - 'True' - 'False' required: true description: Adds a peering to the specified network. name: gcp-compute-networks-add-peering outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the network to delete. name: network required: true description: Deletes the specified network. name: gcp-compute-delete-network outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - auto: PREDEFINED description: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. name: autoCreateSubnetworks predefined: - 'true' - 'false' - auto: PREDEFINED description: The network-wide routing mode to use. If set to REGIONAL, this network's cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's cloud routers will advertise routes with all subnets of this network, across regions. name: routingConfigRoutingMode predefined: - REGIONAL - GLOBAL description: Creates a network in the specified project using the data included in the request. name: gcp-compute-insert-network outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of networks available to the specified project. name: gcp-compute-list-networks outputs: - contextPath: GoogleCloudCompute.Networks.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Networks.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Networks.name description: Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Networks.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Networks.gatewayIPv4 description: The gateway address for default routing out of the network. This value is read only and is selected by GCP. type: string - contextPath: GoogleCloudCompute.Networks.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Networks.autoCreateSubnetworks description: When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. type: boolean - contextPath: GoogleCloudCompute.Networks.subnetworks description: Server-defined fully-qualified URLs for all subnetworks in this VPC network. type: string - contextPath: GoogleCloudCompute.Networks.peerings description: ' A list of network peerings for the resource.' type: string - contextPath: GoogleCloudCompute.Networks.peerings.name description: Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Networks.peerings.network description: The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. type: string - contextPath: GoogleCloudCompute.Networks.peerings.state description: State for the peering. type: string - contextPath: GoogleCloudCompute.Networks.peerings.stateDetails description: Details about the current state of the peering. type: string - contextPath: GoogleCloudCompute.Networks.peerings.autoCreateRoutes description: This field will be deprecated soon. Prefer using exchangeSubnetRoutes instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. type: boolean - contextPath: GoogleCloudCompute.Networks.peerings.exchangeSubnetRoutes description: Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. type: boolean - contextPath: GoogleCloudCompute.Networks.routingConfig description: The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. type: string - contextPath: GoogleCloudCompute.Networks.routingConfig.routingMode description: The network-wide routing mode to use. If set to REGIONAL, this networks cloud routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this networks cloud routers will advertise routes with all subnets of this network, across regions. type: string - contextPath: GoogleCloudCompute.Networks.kind description: Type of the resource. Always compute#network for networks. type: string - arguments: - description: Name of the network resource to remove peering from. name: network required: true - description: Name of the peering, which should conform to RFC1035. name: name required: true description: Removes a peering from the specified network. name: gcp-compute-networks-remove-peering outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the zone for this request. name: zone required: true - description: Name of the Operations resource. name: name required: true description: Wait for a zone operation to complete ,NOTE this command will occupy a system resource. name: gcp-compute-wait-for-zone-operation - arguments: - description: Name of the region for this request. name: region required: true - description: Name of the Operations resource. name: name required: true description: Wait for a region operation to complete ,NOTE this command will occupy a system resource. name: gcp-compute-wait-for-region-operation - arguments: - description: Name of the Operations resource. name: name required: true description: Wait for a global operation to complete ,NOTE this command will occupy a system resource. name: gcp-compute-wait-for-global-operation - arguments: - description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used. name: network - description: Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. name: priority - description: 'If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. comma separated. ' name: sourceRanges - description: If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. comma separated. name: destinationRanges - description: If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. comma separated. name: sourceTags - description: A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. comma separated. name: targetTags - description: If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. comma separated. name: sourceServiceAccounts - description: A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. comma separated. name: targetServiceAccounts - description: 'The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. Ex: ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.' name: allowed - description: 'The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. Ex: ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.' name: denied - description: 'Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.' name: direction - auto: PREDEFINED description: This field denotes whether to enable logging for a particular firewall rule. name: logConfigEnable predefined: - 'true' - 'false' - auto: PREDEFINED description: Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. name: disabled predefined: - 'true' - 'false' - description: Project ID that you want to run this command on. name: project_id description: Creates a firewall rule in the specified project using the data included in the request. name: gcp-compute-insert-firewall outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. name: name required: true - description: An optional description of this resource. Provide this property when you create the resource. name: description - description: URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used. name: network - description: Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. name: priority - description: 'If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. comma separated. ' name: sourceRanges - description: If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. comma separated. name: destinationRanges - description: If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. comma separated. name: sourceTags - description: A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. comma separated. name: targetTags - description: If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. comma separated. name: sourceServiceAccounts - description: A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. comma separated. name: targetServiceAccounts - description: 'The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. Ex: ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.' name: allowed - description: 'The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. Ex: ipprotocol=tcp,ports=22,443;ipprotocol=tcp,ports=8080,80.' name: denied - description: 'Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.' name: direction - auto: PREDEFINED description: This field denotes whether to enable logging for a particular firewall rule. name: logConfigEnable predefined: - 'true' - 'false' - auto: PREDEFINED description: Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. name: disabled predefined: - 'true' - 'false' description: Updates the specified firewall rule with the data included in the request. name: gcp-compute-patch-firewall outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken - description: Project ID that you want to run this command on. name: project_id description: Retrieves the list of firewall rules available to the specified project. name: gcp-compute-list-firewall outputs: - contextPath: GoogleCloudCompute.Firewalls.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Firewalls.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Firewalls.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Firewalls.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Firewalls.network description: URL of the network resource for this firewall rule. type: string - contextPath: GoogleCloudCompute.Firewalls.priority description: Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. type: number - contextPath: GoogleCloudCompute.Firewalls.sourceRanges description: If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. type: string - contextPath: GoogleCloudCompute.Firewalls.destinationRanges description: If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. type: string - contextPath: GoogleCloudCompute.Firewalls.sourceTags description: If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. type: string - contextPath: GoogleCloudCompute.Firewalls.targetTags description: A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. type: string - contextPath: GoogleCloudCompute.Firewalls.sourceServiceAccounts description: If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. type: string - contextPath: GoogleCloudCompute.Firewalls.targetServiceAccounts description: A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. type: string - contextPath: GoogleCloudCompute.Firewalls.allowed description: The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.allowed.IPProtocol description: The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. type: string - contextPath: GoogleCloudCompute.Firewalls.allowed.ports description: An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. type: string - contextPath: GoogleCloudCompute.Firewalls.denied description: The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.denied.IPProtocol description: The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. type: string - contextPath: GoogleCloudCompute.Firewalls.denied.ports description: An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. type: string - contextPath: GoogleCloudCompute.Firewalls.direction description: 'Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.' type: string - contextPath: GoogleCloudCompute.Firewalls.logConfig description: This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.logConfig.enable description: This field denotes whether to enable logging for a particular firewall rule. type: boolean - contextPath: GoogleCloudCompute.Firewalls.disabled description: Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. type: boolean - contextPath: GoogleCloudCompute.Firewalls.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Firewalls.kind description: ' Type of the resource. Always compute#firewall for firewall rules.' type: string - arguments: - description: Name of the firewall rule to return. name: name required: true description: Returns the specified firewall. name: gcp-compute-get-firewall outputs: - contextPath: GoogleCloudCompute.Firewalls.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Firewalls.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Firewalls.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Firewalls.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Firewalls.network description: URL of the network resource for this firewall rule. type: string - contextPath: GoogleCloudCompute.Firewalls.priority description: Priority for this rule. This is an integer between 0 and 65535, both inclusive. When not specified, the value assumed is 1000. Relative priorities determine precedence of conflicting rules. Lower value of priority implies higher precedence (eg, a rule with priority 0 has higher precedence than a rule with priority 1). DENY rules take precedence over ALLOW rules having equal priority. type: number - contextPath: GoogleCloudCompute.Firewalls.sourceRanges description: If source ranges are specified, the firewall will apply only to traffic that has source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. Only IPv4 is supported. type: string - contextPath: GoogleCloudCompute.Firewalls.destinationRanges description: If destination ranges are specified, the firewall will apply only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. type: string - contextPath: GoogleCloudCompute.Firewalls.sourceTags description: If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both properties are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP that belongs to a tag listed in the sourceTags property. The connection does not need to match both properties for the firewall to apply. type: string - contextPath: GoogleCloudCompute.Firewalls.targetTags description: A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. type: string - contextPath: GoogleCloudCompute.Firewalls.sourceServiceAccounts description: If source service accounts are specified, the firewall will apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall will apply to traffic that has source IP address within sourceRanges OR the source IP belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both properties for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. type: string - contextPath: GoogleCloudCompute.Firewalls.targetServiceAccounts description: A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. type: string - contextPath: GoogleCloudCompute.Firewalls.allowed description: The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.allowed.IPProtocol description: The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. type: string - contextPath: GoogleCloudCompute.Firewalls.allowed.ports description: An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. type: string - contextPath: GoogleCloudCompute.Firewalls.denied description: The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.denied.IPProtocol description: The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. type: string - contextPath: GoogleCloudCompute.Firewalls.denied.ports description: An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. type: string - contextPath: GoogleCloudCompute.Firewalls.direction description: 'Direction of traffic to which this firewall applies; default is INGRESS. Note: For INGRESS traffic, it is NOT supported to specify destinationRanges; For EGRESS traffic, it is NOT supported to specify sourceRanges OR sourceTags.' type: string - contextPath: GoogleCloudCompute.Firewalls.logConfig description: This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. type: Unknown - contextPath: GoogleCloudCompute.Firewalls.logConfig.enable description: This field denotes whether to enable logging for a particular firewall rule. type: boolean - contextPath: GoogleCloudCompute.Firewalls.disabled description: Denotes whether the firewall rule is disabled, i.e not applied to the network it is associated with. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. type: boolean - contextPath: GoogleCloudCompute.Firewalls.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Firewalls.kind description: ' Type of the resource. Always compute#firewall for firewall rules.' type: string - arguments: - description: Name of the firewall rule to delete. name: name required: true description: Deletes the specified firewall. name: gcp-compute-delete-firewall outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: Name or id of the resource for this request. name: name required: true - description: A list of labels to apply for this resource. Each label key & value must comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For example, key=abc,value=123;key=abc,value=123. name: labels required: true - description: The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels, otherwise the request will fail with error 412 conditionNotMet. Make a get() request to the resource to get the latest fingerprint. name: labelFingerprint required: true description: Sets the labels on a snapshot. name: gcp-compute-set-snapshot-labels outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - defaultValue: '500' description: 'The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500).' name: maxResults - description: A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. name: filters - description: Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. name: orderBy - description: Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. name: pageToken description: Retrieves the list of Snapshot resources contained within the specified project. name: gcp-compute-list-snapshots outputs: - contextPath: GoogleCloudCompute.Snapshots.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Snapshots.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Snapshots.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Snapshots.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Snapshots.status description: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDisk description: The source disk used to create this snapshot. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskId description: The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. type: string - contextPath: GoogleCloudCompute.Snapshots.diskSizeGb description: Size of the snapshot, specified in GB. type: string - contextPath: GoogleCloudCompute.Snapshots.storageBytes description: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. type: string - contextPath: GoogleCloudCompute.Snapshots.storageBytesStatus description: An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. type: string - contextPath: GoogleCloudCompute.Snapshots.licenses description: A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey description: Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. type: unknown - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. type: Unknown - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Snapshots.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Snapshots.labels description: 'Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' type: Unknown - contextPath: GoogleCloudCompute.Snapshots.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Snapshots.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Snapshots.labelFingerprint description: A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Snapshots.licenseCodes description: ' Integer license codes indicating which licenses are attached to this snapshot.' type: string - contextPath: GoogleCloudCompute.Snapshots.kind description: Type of the resource. Always compute#snapshot for Snapshot resources. type: string - arguments: - description: Name of the Snapshot resource to return. name: name required: true description: Returns the specified Snapshot resource. name: gcp-compute-get-snapshot outputs: - contextPath: GoogleCloudCompute.Snapshots.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Snapshots.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Snapshots.name description: Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Snapshots.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Snapshots.status description: The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDisk description: The source disk used to create this snapshot. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskId description: The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. type: string - contextPath: GoogleCloudCompute.Snapshots.diskSizeGb description: Size of the snapshot, specified in GB. type: string - contextPath: GoogleCloudCompute.Snapshots.storageBytes description: A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. type: string - contextPath: GoogleCloudCompute.Snapshots.storageBytesStatus description: An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. type: string - contextPath: GoogleCloudCompute.Snapshots.licenses description: A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey description: Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the image later For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. type: unknown - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.snapshotEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey description: The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. type: Unknown - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Snapshots.sourceDiskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Snapshots.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Snapshots.labels description: 'Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.' type: Unknown - contextPath: GoogleCloudCompute.Snapshots.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Snapshots.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Snapshots.labelFingerprint description: A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Snapshots.licenseCodes description: ' Integer license codes indicating which licenses are attached to this snapshot.' type: string - contextPath: GoogleCloudCompute.Snapshots.kind description: Type of the resource. Always compute#snapshot for Snapshot resources. type: string - arguments: - description: Name of the Snapshot resource to delete. name: name required: true description: Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. name: gcp-compute-delete-snapshot outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: 'Metadata to be made available to the guest operating system running on the instances. Each entry is a key/value pair separated by '';'' like so: key=abc,value=123;key=abc,value=123.' name: metadata required: true description: Add or update project wide metadata. name: gcp-compute-project-info-add-metadata outputs: - contextPath: GoogleCloudCompute.ProjectMetadata.operationType description: The type of operation, such as insert, update, or delete. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.insertTime description: The time that this operation was started by the server. type: Date - contextPath: GoogleCloudCompute.ProjectMetadata.selfLink description: Server-defined URL for the project. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.targetLink description: The URL of the resource that the operation modifies. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.name description: Name of the operation. type: String - contextPath: GoogleCloudCompute.ProjectMetada.progress description: Progress indicator that ranges from 0 to 100. type: number - contextPath: GoogleCloudCompute.ProjectMetadata.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.startTime description: The time that this operation was started by the server. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.status description: The status of the operation, which can be one of the following PENDING, RUNNING, or DONE. type: String - contextPath: GoogleCloudCompute.ProjectMetadata.kind description: Type of the resource. Always compute#operation. type: String - arguments: - description: Name of the instance scoping this request. name: instance required: true - description: The name of the zone for this request. name: zone required: true - description: Network tag to add. Tag must be unique, 1-63 characters long, and comply with RFC1035. name: tag required: true - description: Project ID that you want to run this command on. name: project_id description: Add network tag for the specified instance. name: gcp-compute-add-network-tag outputs: - contextPath: GoogleCloudCompute.Operations.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Operations.name description: Name of the resource. type: string - contextPath: GoogleCloudCompute.Operations.zone description: The URL of the zone where the operation resides. Only available when performing per-zone operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.clientOperationId description: The value of requestId if you provided it in the request. Not present otherwise. type: string - contextPath: GoogleCloudCompute.Operations.operationType description: The type of operation, such as insert, update, or delete, and so on. type: string - contextPath: GoogleCloudCompute.Operations.targetLink description: The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. type: string - contextPath: GoogleCloudCompute.Operations.targetId description: The unique target ID, which identifies a specific incarnation of the target resource. type: string - contextPath: GoogleCloudCompute.Operations.status description: 'The status of the operation, which can be one of the following: PENDING RUNNING or DONE.' type: string - contextPath: GoogleCloudCompute.Operations.statusMessage description: An optional textual description of the current status of the operation. type: string - contextPath: GoogleCloudCompute.Operations.user description: User who requested the operation for example EMAILADDRESS. type: string - contextPath: GoogleCloudCompute.Operations.progress description: An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. type: number - contextPath: GoogleCloudCompute.Operations.insertTime description: The time that this operation was requested. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.startTime description: The time that this operation was started by the server. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.endTime description: The time that this operation was completed. This value is in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Operations.error description: If errors are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.error.errors description: The array of errors encountered while processing this operation. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.code description: The error type identifier for this error. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.location description: Indicates the field in the request that caused the error. This property is optional. type: string - contextPath: GoogleCloudCompute.Operations.error.errors.message description: An optional, human-readable error message. type: string - contextPath: GoogleCloudCompute.Operations.warnings description: If warning messages are generated during processing of the operation, this field will be populated. type: string - contextPath: GoogleCloudCompute.Operations.warnings.code description: A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. type: string - contextPath: GoogleCloudCompute.Operations.warnings.message description: A human-readable description of the warning code. type: string - contextPath: GoogleCloudCompute.Operations.warnings.data description: 'Metadata about this warning in key: value format.' type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.key description: A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). type: string - contextPath: GoogleCloudCompute.Operations.warnings.data.value description: A warning data value corresponding to the key. type: string - contextPath: GoogleCloudCompute.Operations.httpErrorStatusCode description: If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. type: number - contextPath: GoogleCloudCompute.Operations.httpErrorMessage description: If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. type: string - contextPath: GoogleCloudCompute.Operations.selfLink description: Server-defined URL for the resource. type: string - contextPath: GoogleCloudCompute.Operations.region description: The URL of the region where the operation resides. Only available when performing regional operations. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Operations.description description: A textual description of the operation, which is set when the operation is created. type: string - contextPath: GoogleCloudCompute.Operations.kind description: Type of the resource. Always compute#operation for Operation resources. type: string - arguments: - description: IP Address to search on. name: ip required: true description: Retrieves instance information based on public IP in your project across all regions and zones. name: gcp-compute-aggregated-list-instances-by-ip outputs: - contextPath: GoogleCloudCompute.Instances.id description: The unique identifier for the resource. This identifier is defined by the server. type: string - contextPath: GoogleCloudCompute.Instances.creationTimestamp description: Creation timestamp in RFC3339 text format. type: string - contextPath: GoogleCloudCompute.Instances.name description: The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. type: string - contextPath: GoogleCloudCompute.Instances.description description: An optional description of this resource. Provide this property when you create the resource. type: string - contextPath: GoogleCloudCompute.Instances.tags description: Tags to apply to this instance. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035. Multiple tags can be specified via the tags.items field. type: string - contextPath: GoogleCloudCompute.Instances.tags.items description: An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. type: string - contextPath: GoogleCloudCompute.Instances.tags.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the tags contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update tags. You must always provide an up-to-date fingerprint hash in order to update or change tags. type: string - contextPath: GoogleCloudCompute.Instances.machineType description: 'Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created.' type: string - contextPath: GoogleCloudCompute.Instances.status description: 'The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, STOPPED, SUSPENDING, SUSPENDED, and TERMINATED.' type: string - contextPath: GoogleCloudCompute.Instances.statusMessage description: An optional, human-readable explanation of the status. type: string - contextPath: GoogleCloudCompute.Instances.zone description: URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. type: string - contextPath: GoogleCloudCompute.Instances.canIpForward description: Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces description: An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.network description: URL of the network resource for this instance. When creating an instance, if neither the network nor the subnetwork is specified, the default network global/networks/default is used; if the network is not specified but the subnetwork is specified, the network is inferred. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.subnetwork description: The URL of the Subnetwork resource for this instance. If the network resource is in legacy mode, do not provide this property. If the network is in auto subnet mode, providing the subnetwork is optional. If the network is in custom subnet mode, then this field should be specified. If you specify this property, you can specify the subnetwork as a full or partial URL. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.networkIP description: An IPv4 internal network address to assign to the instance for this network interface. If not specified by the user, an unused internal IP is assigned by the system. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.name description: ' The name of the network interface, generated by the server. For network devices, these are eth0, eth1, etc.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs description: An array of configurations for this interface. Currently, only one access config, ONE_TO_ONE_NAT, is supported. If there are no accessConfigs specified, then this instance will have no external internet access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.type description: The type of configuration. The default and only option is ONE_TO_ONE_NAT. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.name description: The name of this access configuration. The default and recommended name is External NAT but you can use any arbitrary string you would like. For example, My external IP or Network Access. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.natIP description: An external IP address associated with this instance. Specify an unused static external IP address available to the project or leave this field undefined to use an IP from a shared ephemeral IP address pool. If you specify a static external IP address, it must live in the same region as the zone of the instance. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.setPublicPtr description: Specifies whether a public DNS ‘PTR’ record should be created to map the external IP address of the instance to a DNS domain name. type: boolean - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.publicPtrDomainName description: The DNS domain name for the public PTR record. This field can only be set when the setPublicPtr field is enabled. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.networkTier description: 'This signifies the networking tier used for configuring this access configuration and can only take the following values: PREMIUM, STANDARD.' type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.accessConfigs.kind description: Type of the resource. Always compute#accessConfig for access configs. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges description: An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.ipCidrRange description: The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 0.0.0.0), a netmask (e.g. /24) or a CIDR format string (e.g. 0.0.0.0/24). type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.aliasIpRanges.subnetworkRangeName description: Optional subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.fingerprint description: Fingerprint hash of contents stored in this network interface. This field will be ignored when inserting an Instance or adding a NetworkInterface. An up-to-date fingerprint must be provided in order to update the NetworkInterface, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.networkInterfaces.kind description: Type of the resource. Always compute#networkInterface for network interfaces. type: string - contextPath: GoogleCloudCompute.Instances.disks description: Array of disks associated with this instance. Persistent disks must be created before you can assign them. type: string - contextPath: GoogleCloudCompute.Instances.disks.type description: Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. type: string - contextPath: GoogleCloudCompute.Instances.disks.mode description: The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. type: string - contextPath: GoogleCloudCompute.Instances.disks.source description: Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.deviceName description: Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.index description: A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number. type: number - contextPath: GoogleCloudCompute.Instances.disks.boot description: Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. type: boolean - contextPath: GoogleCloudCompute.Instances.disks.initializeParams description: Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskName description: Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImage description: The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or disks.source is required except for local SSD. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskSizeGb description: Specifies the size of the disk in base-2 GB. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.diskType description: Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey description: The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.sourceImageEncryptionKey.kmsKeyName description: 'The name of the encryption key that is stored in Google Cloud KMS. ' type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels description: Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.key description: The disk label key. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.labels.value description: The disk label value. type: string - contextPath: GoogleCloudCompute.Instances.disks.initializeParams.description description: An optional description. Provide this property when creating the disk. type: string - contextPath: GoogleCloudCompute.Instances.disks.autoDelete description: Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). type: boolean - contextPath: GoogleCloudCompute.Instances.disks.licenses description: ' Any valid publicly visible licenses.' type: string - contextPath: GoogleCloudCompute.Instances.disks.interface description: Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures description: A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.guestOsFeatures.type description: The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey description: Encrypts or decrypts a disk using a customer-supplied encryption key. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.rawKey description: Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.kmsKeyName description: The name of the encryption key that is stored in Google Cloud KMS. type: string - contextPath: GoogleCloudCompute.Instances.disks.diskEncryptionKey.sha256 description: The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource. type: string - contextPath: GoogleCloudCompute.Instances.disks.kind description: Type of the resource. Always compute#attachedDisk for attached disks. type: string - contextPath: GoogleCloudCompute.Instances.metadata description: The metadata key/value pairs assigned to this instance. This includes custom metadata and predefined keys. type: string - contextPath: GoogleCloudCompute.Instances.metadata.fingerprint description: Specifies a fingerprint for this request, which is essentially a hash of the metadatas contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items description: Array of key/value pairs. The total size of all keys and values must be less than 512 KB. type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.key description: 'Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.' type: string - contextPath: GoogleCloudCompute.Instances.metadata.items.value description: Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). type: string - contextPath: GoogleCloudCompute.Instances.metadata.kind description: Type of the resource. Always compute#metadata for metadata. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts description: A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.email description: Email address of the service account. type: string - contextPath: GoogleCloudCompute.Instances.serviceAccounts.scopes description: The list of scopes to be made available for this service account. type: string - contextPath: GoogleCloudCompute.Instances.selfLink description: Server-defined URL for this resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling description: Sets the scheduling options for this instance. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.onHostMaintenance description: Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Setting Instance Scheduling Options. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.automaticRestart description: Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.preemptible description: Defines whether the instance is preemptible. This can only be set during instance creation, it cannot be set or changed after the instance has been created. type: boolean - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities description: A set of node affinity and anti-affinity. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.key description: Corresponds to the label key of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.operator description: Defines the operation of node selection. type: string - contextPath: GoogleCloudCompute.Instances.scheduling.nodeAffinities.values description: Corresponds to the label values of Node resource. type: string - contextPath: GoogleCloudCompute.Instances.cpuPlatform description: The CPU platform used by this instance. type: string - contextPath: GoogleCloudCompute.Instances.labels description: Labels to apply to this instance. These can be later modified by the setLabels method. type: string - contextPath: GoogleCloudCompute.Instances.labels.key description: The label key. type: string - contextPath: GoogleCloudCompute.Instances.labels.value description: The label value. type: string - contextPath: GoogleCloudCompute.Instances.labelFingerprint description: A fingerprint for this request, which is essentially a hash of the labels contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. type: string - contextPath: GoogleCloudCompute.Instances.minCpuPlatform description: 'Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge".' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators description: A list of the type and count of accelerator cards attached to the instance. type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorType description: 'Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.' type: string - contextPath: GoogleCloudCompute.Instances.guestAccelerators.acceleratorCount description: The number of the guest accelerator cards exposed to this instance. type: string - contextPath: GoogleCloudCompute.Instances.startRestricted description: Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. type: boolean - contextPath: GoogleCloudCompute.Instances.deletionProtection description: Whether the resource should be protected against deletion. type: boolean - contextPath: GoogleCloudCompute.Instances.hostname description: Hostname. type: string - contextPath: GoogleCloudCompute.Instances.kind description: '] Type of the resource. Always compute#instance for instances.' type: string dockerimage: demisto/googleapi-python3:1.0.0.4114363 script: '' subtype: python3 type: python tests: - No tests sectionorder: - Connect - Collect fromversion: 5.0.0