Resources

A resource represents a single Google Cloud Platform entity, such as a Compute Engine virtual machine instance, a BigQuery dataset, a Cloud Storage bucket, and so on. You define a list of resources in your configuration file, which is then deployed using the Deployment Manager service.

For a list of methods for this resource, see the end of this page.

Resource representations



{  
 "id" 
 : 
  
  unsigned 
  
 long 
 
 , 
  
 "name" 
 : 
  
  string 
 
 , 
  
 "type" 
 : 
  
  string 
 
 , 
  
 "manifest" 
 : 
  
  string 
 
 , 
  
 "url" 
 : 
  
  string 
 
 , 
  
 "properties" 
 : 
  
  string 
 
 , 
  
 "finalProperties" 
 : 
  
  string 
 
 , 
  
 "accessControl" 
 : 
  
{  
 "gcpIamPolicy" 
 : 
  
  string 
 
  
} , 
  
 "update" 
 : 
  
{  
 "manifest" 
 : 
  
  string 
 
 , 
  
 "error" 
 : 
  
{  
 "errors" 
 : 
  
 [ 
  
{  
 "code" 
 : 
  
  string 
 
 , 
  
 "location" 
 : 
  
  string 
 
 , 
  
 "message" 
 : 
  
  string 
 
  
}  
 ] 
  
} , 
  
 "warnings" 
 : 
  
 [ 
  
{  
 "code" 
 : 
  
  string 
 
 , 
  
 "message" 
 : 
  
  string 
 
 , 
  
 "data" 
 : 
  
 [ 
  
{  
 "key" 
 : 
  
  string 
 
 , 
  
 "value" 
 : 
  
  string 
 
  
}  
 ] 
  
}  
 ], 
  
 "state" 
 : 
  
  string 
 
 , 
  
 "intent" 
 : 
  
  string 
 
 , 
  
 "properties" 
 : 
  
  string 
 
 , 
  
 "finalProperties" 
 : 
  
  string 
 
 , 
  
 "accessControl" 
 : 
  
{  
 "gcpIamPolicy" 
 : 
  
  string 
 
  
}  
} , 
  
 "insertTime" 
 : 
  
  string 
 
 , 
  
 "updateTime" 
 : 
  
  string 
 
 , 
  
 "warnings" 
 : 
  
 [ 
  
{  
 "code" 
 : 
  
  string 
 
 , 
  
 "message" 
 : 
  
  string 
 
 , 
  
 "data" 
 : 
  
 [ 
  
{  
 "key" 
 : 
  
  string 
 
 , 
  
 "value" 
 : 
  
  string 
 
  
}  
 ] 
  
}  
 ] 
}
Property name Value Description Notes
accessControl
nested object The Access Control Policy set on this resource.
accessControl. gcpIamPolicy
string The GCP IAM Policy to set on the resource.
finalProperties
string Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.
id
unsigned long
insertTime
string Output only. Creation timestamp in RFC3339 text format.
manifest
string Output only. URL of the manifest representing the current configuration of this resource.
name
string Output only. The name of the resource as it appears in the YAML config.
properties
string Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.
type
string Output only. The type of the resource, for example compute.v1.instance , or cloudfunctions.v1beta1.function .
update
nested object Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.
update. accessControl
nested object The Access Control Policy to set on this resource after updating the resource itself.
update.accessControl. gcpIamPolicy
string The GCP IAM Policy to set on the resource.
update. error
object Output only. If errors are generated during update of the resource, this field will be populated.
update.error. errors[]
list [Output Only] The array of errors encountered while processing this operation.
update.error.errors[]. code
string [Output Only] The error type identifier for this error.
update.error.errors[]. location
string [Output Only] Indicates the field in the request that caused the error. This property is optional.
update.error.errors[]. message
string [Output Only] An optional, human-readable error message.
update. finalProperties
string Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.
update. intent
string Output only. The intent of the resource: PREVIEW , UPDATE , or CANCEL .
update. manifest
string Output only. URL of the manifest representing the update configuration of this resource.
update. properties
string Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.
update. state
string Output only. The state of the resource.
update. warnings[]
list Output only. If warning messages are generated during processing of this resource, this field will be populated.
update.warnings[]. code
string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
update.warnings[]. data[]
list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
update.warnings[].data[]. key
string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
update.warnings[].data[]. value
string [Output Only] A warning data value corresponding to the key.
update.warnings[]. message
string [Output Only] A human-readable description of the warning code.
updateTime
string Output only. Update timestamp in RFC3339 text format.
url
string Output only. The URL of the actual resource.
warnings[]
list Output only. If warning messages are generated during processing of this resource, this field will be populated.
warnings[]. code
string [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
warnings[]. data[]
list [Output Only] Metadata about this warning in key: value format. For example:
"data": [ { "key": "scope", "value": "zones/us-east1-d" }
warnings[].data[]. key
string [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
warnings[].data[]. value
string [Output Only] A warning data value corresponding to the key.
warnings[]. message
string [Output Only] A human-readable description of the warning code.

Methods

get
Gets information about a single resource.
list
Lists all resources in a given deployment.
Design a Mobile Site
View Site in Mobile | Classic
Share by: