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

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

[diff] [blame]

81

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

Sai Cheemalapati

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

[diff] [blame]

82

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

83

84

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

85

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

86

<h3>Method Details</h3>

87

88

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

89

<pre>Gets information about a single resource.

90

91

Args:

92

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

93

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

94

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

95

96

Returns:

97

An object of the form:

98

99

{

Bu Sun Kim

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

[diff] [blame]

100

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

101

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

Sai Cheemalapati

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

[diff] [blame]

102

},

Bu Sun Kim

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

[diff] [blame]

103

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

104

"id": "A String",

105

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

106

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

107

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

108

"password": "A String",

109

"user": "A String",

110

},

111

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

112

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

113

},

114

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

115

},

116

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

117

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

118

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

119

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

120

"A String",

121

],

Bu Sun Kim

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

[diff] [blame]

122

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

Bu Sun Kim

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

[diff] [blame]

123

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

124

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

125

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

126

},

127

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

128

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

129

"password": "A String",

130

"user": "A String",

131

},

132

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

133

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

134

},

135

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

136

},

137

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

138

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

Sai Cheemalapati

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

[diff] [blame]

139

{

Bu Sun Kim

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

[diff] [blame]

140

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

141

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

142

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

Sai Cheemalapati

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

[diff] [blame]

143

},

144

],

145

},

Bu Sun Kim

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

[diff] [blame]

146

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

Bu Sun Kim

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

[diff] [blame]

147

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

148

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

149

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

150

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

151

"A String",

152

],

153

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

154

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

155

{

Bu Sun Kim

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

[diff] [blame]

156

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

157

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

158

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

Sai Cheemalapati

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

[diff] [blame]

159

{

Bu Sun Kim

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

[diff] [blame]

160

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

161

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

Sai Cheemalapati

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

[diff] [blame]

162

},

163

],

Bu Sun Kim

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

[diff] [blame]

164

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

Sai Cheemalapati

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

[diff] [blame]

165

},

166

],

Bu Sun Kim

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

[diff] [blame]

167

},

168

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

169

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

170

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

171

{

172

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

173

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

174

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

Sai Cheemalapati

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

[diff] [blame]

175

{

Bu Sun Kim

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

[diff] [blame]

176

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

177

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

Sai Cheemalapati

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

[diff] [blame]

178

},

179

],

Bu Sun Kim

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

[diff] [blame]

180

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

Sai Cheemalapati

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

[diff] [blame]

181

},

Bu Sun Kim

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

[diff] [blame]

182

],

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

187

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

Sai Cheemalapati

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

[diff] [blame]

188

<pre>Lists all resources in a given deployment.

189

190

Args:

191

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

192

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

Bu Sun Kim

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

[diff] [blame]

193

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]

194

Bu Sun Kim

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

[diff] [blame]

195

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]

196

Bu Sun Kim

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

[diff] [blame]

197

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]

198

Bu Sun Kim

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

[diff] [blame]

199

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

200

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]

201

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

202

Bu Sun Kim

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

[diff] [blame]

203

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]

204

Bu Sun Kim

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

[diff] [blame]

205

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

206

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.

207

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.

Sai Cheemalapati

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

[diff] [blame]

208

209

Returns:

210

An object of the form:

211

212

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

213

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

214

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

Sai Cheemalapati

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

[diff] [blame]

215

{

Bu Sun Kim

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

[diff] [blame]

216

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

217

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

Sai Cheemalapati

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

[diff] [blame]

218

},

Bu Sun Kim

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

[diff] [blame]

219

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

220

"id": "A String",

221

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

222

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

223

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

224

"password": "A String",

225

"user": "A String",

226

},

227

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

228

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

229

},

230

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

231

},

232

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

233

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

234

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

235

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

236

"A String",

237

],

Bu Sun Kim

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

[diff] [blame]

238

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

Bu Sun Kim

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

[diff] [blame]

239

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

240

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

241

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

242

},

243

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

244

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

245

"password": "A String",

246

"user": "A String",

247

},

248

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

249

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

250

},

251

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

252

},

253

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

254

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

Sai Cheemalapati

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

[diff] [blame]

255

{

Bu Sun Kim

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

[diff] [blame]

256

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

257

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

258

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

Sai Cheemalapati

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

[diff] [blame]

259

},

260

],

261

},

Bu Sun Kim

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

[diff] [blame]

262

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

Bu Sun Kim

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

[diff] [blame]

263

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

264

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

265

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

266

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

267

"A String",

268

],

269

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

270

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

271

{

Bu Sun Kim

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

[diff] [blame]

272

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

273

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

274

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

Sai Cheemalapati

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

[diff] [blame]

275

{

Bu Sun Kim

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

[diff] [blame]

276

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

277

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

Sai Cheemalapati

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

[diff] [blame]

278

},

279

],

Bu Sun Kim

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

[diff] [blame]

280

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

Sai Cheemalapati

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

[diff] [blame]

281

},

282

],

Bu Sun Kim

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

[diff] [blame]

283

},

284

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

285

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

286

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

287

{

288

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

289

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

290

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

Sai Cheemalapati

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

[diff] [blame]

291

{

Bu Sun Kim

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

[diff] [blame]

292

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

293

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

Sai Cheemalapati

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

[diff] [blame]

294

},

295

],

Bu Sun Kim