Blame - docs/dyn/deploymentmanager_alpha.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-13 12:12:03 -0400

[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, filter=None, maxResults=None, orderBy=None, returnPartialSuccess=None, pageToken=None)</a></code></p>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[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-13 12:12:03 -0400

[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

{

Dmitry Frenkel

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

[diff] [blame^]

108

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

109

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

110

{

111

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

112

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

113

{

114

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

115

"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).

116

},

117

],

118

"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.

119

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

Bu Sun Kim

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

[diff] [blame]

120

},

Dmitry Frenkel

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

[diff] [blame^]

121

],

Bu Sun Kim

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

[diff] [blame]

122

"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment

123

"A String",

124

],

Dmitry Frenkel

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

[diff] [blame^]

125

"id": "A String",

126

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

127

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

128

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

129

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

Bu Sun Kim

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

[diff] [blame]

130

"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^]

131

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

132

"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.

133

"A String",

134

],

135

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

136

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

137

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

138

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

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

},

142

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The credential that will be used creating/updating this resource.

Dmitry Frenkel

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

[diff] [blame^]

143

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

144

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

145

"password": "A String",

146

"user": "A String",

147

},

148

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

149

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

150

},

Bu Sun Kim

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

[diff] [blame]

151

},

Bu Sun Kim

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

[diff] [blame]

152

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

153

{

Dmitry Frenkel

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

[diff] [blame^]

154

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

Bu Sun Kim

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

[diff] [blame]

155

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

156

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

157

{

Bu Sun Kim

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

[diff] [blame]

158

"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).

159

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

160

},

161

],

Dmitry Frenkel

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

[diff] [blame^]

162

"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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

163

},

164

],

Dmitry Frenkel

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

[diff] [blame^]

165

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

166

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

167

{

Dmitry Frenkel

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

[diff] [blame^]

168

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

169

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

170

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

171

},

172

],

173

},

Dmitry Frenkel

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

[diff] [blame^]

174

},

175

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

176

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

177

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

178

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

179

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

180

},

181

"lastUsedCredential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The last used credential that successfully created/updated the resource.

182

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

183

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

184

"password": "A String",

185

"user": "A String",

186

},

187

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

188

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

189

},

190

},

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

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

[diff] [blame^]

195

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

196

<pre>Lists all resources in a given deployment.

197

198

Args:

199

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

200

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

Bu Sun Kim

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

[diff] [blame]

201

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 `<`.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

202

Bu Sun Kim

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

[diff] [blame]

203

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

204

Bu Sun Kim

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

[diff] [blame]

205

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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

206

Bu Sun Kim

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

[diff] [blame]

207

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) ```

208

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]

209

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

210

Bu Sun Kim

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

[diff] [blame]

211

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]

212

Bu Sun Kim

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

[diff] [blame]

213

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

Bu Sun Kim

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

[diff] [blame]

214

returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.

Dmitry Frenkel

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

[diff] [blame^]

215

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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

216

217

Returns:

218

An object of the form:

219

220

{ # 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]

221

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

222

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

223

{

Dmitry Frenkel

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

[diff] [blame^]

224

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

225

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

226

{

227

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

228

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

229

{

230

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

231

"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).

232

},

233

],

234

"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.

235

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

Bu Sun Kim

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

[diff] [blame]

236

},

Dmitry Frenkel

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

[diff] [blame^]

237

],

Bu Sun Kim

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

[diff] [blame]

238

"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies on which this action will run in the deployment

239

"A String",

240

],

Dmitry Frenkel

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

[diff] [blame^]

241

"id": "A String",

242

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

243

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

244

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

245

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

Bu Sun Kim

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

[diff] [blame]

246

"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^]

247

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

248

"runtimePolicies": [ # Output only. In case this is an action, it will show the runtimePolicies that this action will have after updating the deployment.

249

"A String",

250

],

251

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

252

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

253

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

254

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

Bu Sun Kim

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

[diff] [blame]

255

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

256

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

257

},

258

"credential": { # The credential used by Deployment Manager and TypeProvider. Only one of the options is permitted. # Output only. The credential that will be used creating/updating this resource.

Dmitry Frenkel

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

[diff] [blame^]

259

"useProjectDefault": True or False, # Specify to use the project default credential, only supported by Deployment.

Bu Sun Kim

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

[diff] [blame]

260

"basicAuth": { # Basic Auth used as a credential. # Basic Auth Credential, only used by TypeProvider.

261

"password": "A String",

262

"user": "A String",

263

},

264

"serviceAccount": { # Service Account used as a credential. # Service Account Credential, only used by Deployment.

265

"email": "A String", # The IAM service account email address like test@myproject.iam.gserviceaccount.com

266

},

Bu Sun Kim

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

[diff] [blame]

267

},

Bu Sun Kim

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

[diff] [blame]

268

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

269

{

Dmitry Frenkel

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

[diff] [blame^]

270

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

Bu Sun Kim

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

[diff] [blame]

271

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

272

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

273

{

Bu Sun Kim

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

[diff] [blame]

274

"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).

275

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

276

},

277

],

Dmitry Frenkel

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

[diff] [blame^]

278

"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.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

279

},

280

],

Dmitry Frenkel

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

[diff] [blame^]

281

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

282

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

283

{

Dmitry Frenkel

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

[diff] [blame^]

284

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

285

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

286

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

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

287

},

288

],

289

},

Dmitry Frenkel