Blame - docs/dyn/deploymentmanager_v2beta.resources.html - platform/external/python/google-api-python-client

2020-10-06 16:46:05 -0700

[diff] [blame^]

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

81

<code><a href="#get">get(project, deployment, resource)</a></code></p>

82

<p class="firstline">Gets information about a single resource.</p>

83

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

84

<code><a href="#list">list(project, deployment, maxResults=None, orderBy=None, pageToken=None, filter=None)</a></code></p>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

85

<p class="firstline">Lists all resources in a given deployment.</p>

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

<h3>Method Details</h3>

90

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

91

<code class="details" id="close">close()</code>

92

<pre>Close httplib2 connections.</pre>

</div>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

96

<code class="details" id="get">get(project, deployment, resource)</code>

97

<pre>Gets information about a single resource.

98

99

Args:

100

project: string, The project ID for this request. (required)

101

deployment: string, The name of the deployment for this request. (required)

102

resource: string, The name of the resource for this request. (required)

103

104

Returns:

105

An object of the form:

106

107

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

108

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

109

"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.

110

{

111

"code": "A 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.

112

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

113

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

114

{

115

"value": "A String", # [Output Only] A warning data value corresponding to the key.

116

"key": "A 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).

117

},

118

],

119

"message": "A String", # [Output Only] A human-readable description of the warning code.

120

},

121

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

122

"accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.

123

"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.

124

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

125

"state": "A String", # Output only. The state of the resource.

126

"finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.

127

"properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.

128

"intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

"error": { # Output only. If errors are generated during update of the resource, this field will be populated.

130

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

131

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

132

"code": "A String", # [Output Only] The error type identifier for this error.

133

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

134

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

135

},

136

],

137

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

138

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

139

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

140

"id": "A String",

141

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

142

"accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.

143

"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.

144

},

145

"manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

146

"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.

147

{

148

"code": "A 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.

149

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

150

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

151

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

152

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

153

"key": "A 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).

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

154

},

155

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

156

"message": "A String", # [Output Only] A human-readable description of the warning code.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

157

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

158

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

159

"url": "A String", # Output only. The URL of the actual resource.

160

"finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.

161

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

162

"type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.

163

"name": "A String", # Output only. The name of the resource as it appears in the YAML config.

164

"properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

169

<code class="details" id="list">list(project, deployment, maxResults=None, orderBy=None, pageToken=None, filter=None)</code>

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

170

<pre>Lists all resources in a given deployment.

171

172

Args:

173

project: string, The project ID for this request. (required)

174

deployment: string, The name of the deployment for this request. (required)

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

175

maxResults: integer, 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`)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

177

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

178

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

179

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

180

Currently, only sorting by `name` or `creationTimestamp desc` is supported.

181

pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

182

filter: string, 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 `<`.

183

184

For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.

185

186

You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

187

188

To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

189

190

Returns:

191

An object of the form:

192

193

{ # A response containing a partial list of resources and a page token used to build the next request if the request has been truncated.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

194

"nextPageToken": "A String", # A token used to continue a truncated list request.

195

"resources": [ # Resources contained in this list response.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

196

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

197

"update": { # Output only. If Deployment Manager is currently updating or previewing an update to this resource, the updated configuration appears here.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

198

"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.

199

{

200

"code": "A 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.

201

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

202

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

203

{

204

"value": "A String", # [Output Only] A warning data value corresponding to the key.

205

"key": "A 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).

206

},

207

],

208

"message": "A String", # [Output Only] A human-readable description of the warning code.

209

},

210

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

211

"accessControl": { # The access controls set on the resource. # The Access Control Policy to set on this resource after updating the resource itself.

212

"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.

213

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

214

"state": "A String", # Output only. The state of the resource.

215

"finalProperties": "A String", # Output only. The expanded properties of the resource with reference values expanded. Returned as serialized YAML.

216

"properties": "A String", # Output only. The set of updated properties for this resource, before references are expanded. Returned as serialized YAML.

217

"intent": "A String", # Output only. The intent of the resource: `PREVIEW`, `UPDATE`, or `CANCEL`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

218

"error": { # Output only. If errors are generated during update of the resource, this field will be populated.

219

"errors": [ # [Output Only] The array of errors encountered while processing this operation.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

220

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

221

"code": "A String", # [Output Only] The error type identifier for this error.

222

"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.

223

"message": "A String", # [Output Only] An optional, human-readable error message.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

224

},

225

],

226

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

227

"manifest": "A String", # Output only. URL of the manifest representing the update configuration of this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

228

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

229

"id": "A String",

230

"insertTime": "A String", # Output only. Creation timestamp in RFC3339 text format.

231

"accessControl": { # The access controls set on the resource. # The Access Control Policy set on this resource.

232

"gcpIamPolicy": "A String", # The GCP IAM Policy to set on the resource.

233

},

234

"manifest": "A String", # Output only. URL of the manifest representing the current configuration of this resource.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

235

"warnings": [ # Output only. If warning messages are generated during processing of this resource, this field will be populated.

236

{

237

"code": "A 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.

238

"data": [ # [Output Only] Metadata about this warning in key: value format. For example:

239

# "data": [ { "key": "scope", "value": "zones/us-east1-d" }

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

240

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

241

"value": "A String", # [Output Only] A warning data value corresponding to the key.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

242

"key": "A 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).

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

243

},

244

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"message": "A String", # [Output Only] A human-readable description of the warning code.

Sai Cheemalapati

2017-03-24 15:06:46 -0700

[diff] [blame]

246

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

248

"url": "A String", # Output only. The URL of the actual resource.

249

"finalProperties": "A String", # Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML.

250

"updateTime": "A String", # Output only. Update timestamp in RFC3339 text format.

251

"type": "A String", # Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`.

252

"name": "A String", # Output only. The name of the resource as it appears in the YAML config.

253

"properties": "A String", # Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML.

Sai Cheemalapati