Blame - docs/dyn/datamigration_v1beta1.projects.locations.connectionProfiles.html - platform/external/python/google-api-python-client

<h1><a href="datamigration_v1beta1.html">Database Migration API</a> . <a href="datamigration_v1beta1.projects.html">projects</a> . <a href="datamigration_v1beta1.projects.locations.html">locations</a> . <a href="datamigration_v1beta1.projects.locations.connectionProfiles.html">connectionProfiles</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

79

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

80

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

81

<code><a href="#create">create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

82

<p class="firstline">Creates a new connection profile in a given project and location.</p>

83

84

<code><a href="#delete">delete(name, force=None, requestId=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.</p>

86

87

<code><a href="#get">get(name, x__xgafv=None)</a></code></p>

88

<p class="firstline">Gets details of a single connection profile.</p>

89

90

<code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>

92

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

93

<code><a href="#list">list(parent, orderBy=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

94

<p class="firstline">Retrieve a list of all connection profiles in a given project and location.</p>

95

96

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

97

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

98

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

99

<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

100

<p class="firstline">Update the configuration of a single connection profile.</p>

101

102

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

103

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.</p>

104

105

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

106

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

107

<h3>Method Details</h3>

108

109

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

110

<pre>Close httplib2 connections.</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

114

<code class="details" id="create">create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)</code>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

115

<pre>Creates a new connection profile in a given project and location.

116

117

Args:

118

parent: string, Required. The parent, which owns this collection of connection profiles. (required)

119

body: object, The request body.

120

The object takes the form of:

121

122

{ # A connection profile definition.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

123

"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

124

"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.

125

"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.

126

"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.

127

"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.

128

"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.

129

"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

130

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

131

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

132

"host": "A String", # Required. The IP or hostname of the source MySQL database.

133

"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.

134

"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

135

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

136

"port": 42, # Required. The network port of the source MySQL database.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

137

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

138

"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).

139

"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.

140

"provider": "A String", # The database provider.

141

"displayName": "A String", # The connection profile display name.

142

"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.

143

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.

144

"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).

145

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

146

"rootPassword": "A String", # Input only. Initial root password.

147

"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.

148

"a_key": "A String",

149

},

150

"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.

151

"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.

152

"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.

153

"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

154

"a_key": "A String",

155

},

156

"databaseVersion": "A String", # The database engine type and version (such as `MYSQL_5_7` / `POSTGRES_9_6`).

157

"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

158

"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

159

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.

160

"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`

161

"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

162

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.

163

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).

164

{ # An entry for an Access Control list.

165

"ttl": "A String", # Input only. The time-to-leave of this access control entry.

166

"label": "A String", # A label to identify this entry.

167

"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.

168

"value": "A String", # The allowlisted value for the access control list.

169

},

170

],

171

"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.

172

"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.

173

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

174

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

175

"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.

176

"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.

177

"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

178

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

179

"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.

180

"a_key": "A String",

181

},

182

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

183

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.

184

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

185

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

186

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

187

{

188

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

193

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

194

connectionProfileId: string, Required. The connection profile identifier.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

195

requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

196

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

203

204

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

205

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

206

"a_key": "", # Properties of the object. Contains field @type with type URL.

207

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

208

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

209

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

210

"a_key": "", # Properties of the object. Contains field @type with type URL.

211

},

212

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

213

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

214

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

215

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

216

{

217

"a_key": "", # Properties of the object. Contains field @type with type URL.

218

},

219

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

220

},

221

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

<code class="details" id="delete">delete(name, force=None, requestId=None, x__xgafv=None)</code>

227

<pre>Deletes a single Database Migration Service connection profile. A connection profile can only be deleted if it is not in use by any active migration jobs.

228

229

Args:

230

name: string, Required. Name of the connection profile resource to delete. (required)

231

force: boolean, In case of force delete, the CloudSQL replica database is also deleted (only for CloudSQL connection profile).

232

requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

233

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

240

241

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

242

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

243

"a_key": "", # Properties of the object. Contains field @type with type URL.

244

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

245

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

246

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

247

"a_key": "", # Properties of the object. Contains field @type with type URL.

248

},

249

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

250

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

251

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

252

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

253

{

254

"a_key": "", # Properties of the object. Contains field @type with type URL.

255

},

256

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

257

},

258

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

264

<pre>Gets details of a single connection profile.

265

266

Args:

267

name: string, Required. Name of the connection profile resource to get. (required)

268

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

275

276

{ # A connection profile definition.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

277

"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

278

"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.

279

"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.

280

"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.

281

"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.

282

"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.

283

"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

284

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

285

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

286

"host": "A String", # Required. The IP or hostname of the source MySQL database.

287

"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.

288

"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

289

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

290

"port": 42, # Required. The network port of the source MySQL database.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

291

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

292

"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).

293

"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.

294

"provider": "A String", # The database provider.

295

"displayName": "A String", # The connection profile display name.

296

"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.

297

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.

298

"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).

299

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

300

"rootPassword": "A String", # Input only. Initial root password.

301

"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.

302

"a_key": "A String",

303

},

304

"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.

305

"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.

306

"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.

307

"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

308

"a_key": "A String",

309

},

310

"databaseVersion": "A String", # The database engine type and version (such as `MYSQL_5_7` / `POSTGRES_9_6`).

311

"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

312

"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

313

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.

314

"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`

315

"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

316

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.

317

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).

318

{ # An entry for an Access Control list.

319

"ttl": "A String", # Input only. The time-to-leave of this access control entry.

320

"label": "A String", # A label to identify this entry.

321

"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.

322

"value": "A String", # The allowlisted value for the access control list.

323

},

324

],

325

"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.

326

"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.

327

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

328

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

329

"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.

330

"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.

331

"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

332

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

333

"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.

334

"a_key": "A String",

335

},

336

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

337

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.

338

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

339

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

340

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

341

{

342

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}</pre>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

</div>

<code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>

351

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

352

353

Args:

354

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

355

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

356

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

363

364

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

365

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

366

{ # Associates `members` with a `role`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

367

"bindingId": "A String",

368

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

369

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

370

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

371

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

372

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

373

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

374

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

375

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

376

"A String",

377

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

378

},

379

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

380

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

381

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

382

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

383

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

384

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

385

"auditLogConfigs": [ # The configuration for logging of each type of permission.

386

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

387

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

388

"A String",

389

],

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

390

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

},

],

},

],

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

399

<code class="details" id="list">list(parent, orderBy=None, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

400

<pre>Retrieve a list of all connection profiles in a given project and location.

401

402

Args:

403

parent: string, Required. The parent, which owns this collection of connection profiles. (required)

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

404

orderBy: string, the order by fields for the result.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

405

pageSize: integer, The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

406

filter: string, A filter expression that filters connection profiles 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, list connection profiles created this year by specifying **createTime %gt; 2020-01-01T00:00:00.000000000Z**. You can also filter nested fields. For example, you could specify **mySql.username = %lt;my_username%gt;** to list all connection profiles configured to connect with a specific username.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

407

pageToken: string, A page token, received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

408

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

415

416

{ # Response message for 'ListConnectionProfiles' request.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

417

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

418

"unreachable": [ # Locations that could not be reached.

419

"A String",

420

],

421

"connectionProfiles": [ # The response list of connection profiles.

422

{ # A connection profile definition.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

423

"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

424

"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.

425

"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.

426

"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.

427

"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.

428

"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.

429

"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

430

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

431

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

432

"host": "A String", # Required. The IP or hostname of the source MySQL database.

433

"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.

434

"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

435

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

436

"port": 42, # Required. The network port of the source MySQL database.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

437

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

438

"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).

439

"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.

440

"provider": "A String", # The database provider.

441

"displayName": "A String", # The connection profile display name.

442

"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.

443

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.

444

"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).

445

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

446

"rootPassword": "A String", # Input only. Initial root password.

447

"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.

448

"a_key": "A String",

449

},

450

"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.

451

"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.

452

"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.

453

"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

454

"a_key": "A String",

455

},

456

"databaseVersion": "A String", # The database engine type and version (such as `MYSQL_5_7` / `POSTGRES_9_6`).

457

"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

458

"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

459

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.

460

"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`

461

"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

462

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.

463

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).

464

{ # An entry for an Access Control list.

465

"ttl": "A String", # Input only. The time-to-leave of this access control entry.

466

"label": "A String", # A label to identify this entry.

467

"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.

468

"value": "A String", # The allowlisted value for the access control list.

469

},

470

],

471

"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.

472

"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.

473

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

474

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

475

"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.

476

"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.

477

"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

478

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

479

"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.

480

"a_key": "A String",

481

},

482

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

483

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.

484

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

485

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

486

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

487

{

488

"a_key": "", # Properties of the object. Contains field @type with type URL.

489

},

490

],

491

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

492

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

493

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

499

<pre>Retrieves the next page of results.

500

501

Args:

502

previous_request: The request for the previous page. (required)

503

previous_response: The response from the request for the previous page. (required)

504

505

Returns:

506

A request object that you can call 'execute()' on to request the next

507

page. Returns None if there are no more items in the collection.

</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

512

<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

513

<pre>Update the configuration of a single connection profile.

514

515

Args:

516

name: string, The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}. (required)

517

body: object, The request body.

518

The object takes the form of:

519

520

{ # A connection profile definition.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

521

"createTime": "A String", # Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

522

"mysql": { # Specifies connection parameters required specifically for MySQL databases. # A MySQL database connection profile.

523

"ssl": { # SSL configuration information. # SSL configuration for the destination to connect to the source database.

524

"clientKey": "A String", # Input only. The unencrypted PKCS#1 or PKCS#8 PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' field is mandatory.

525

"clientCertificate": "A String", # Input only. The x509 PEM-encoded certificate that will be used by the replica to authenticate against the source database server.If this field is used then the 'client_key' field is mandatory.

526

"caCertificate": "A String", # Required. Input only. The x509 PEM-encoded certificate of the CA that signed the source database server's certificate. The replica will use this certificate to verify it's connecting to the right host.

527

"type": "A String", # Output only. The ssl config type according to 'client_key', 'client_certificate' and 'ca_certificate'.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

528

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

529

"password": "A String", # Required. Input only. The password for the user that Database Migration Service will be using to connect to the database. This field is not returned on request, and the value is encrypted when stored in Database Migration Service.

530

"host": "A String", # Required. The IP or hostname of the source MySQL database.

531

"passwordSet": True or False, # Output only. Indicates If this connection profile password is stored.

532

"cloudSqlId": "A String", # If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.

533

"username": "A String", # Required. The username that Database Migration Service will use to connect to the database. The value is encrypted when stored in Database Migration Service.

534

"port": 42, # Required. The network port of the source MySQL database.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

535

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

536

"state": "A String", # The current connection profile state (e.g. DRAFT, READY, or FAILED).

537

"name": "A String", # The name of this connection profile resource in the form of projects/{project}/locations/{location}/instances/{instance}.

538

"provider": "A String", # The database provider.

539

"displayName": "A String", # The connection profile display name.

540

"cloudsql": { # Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. # A CloudSQL database connection profile.

541

"settings": { # Settings for creating a Cloud SQL database instance. # Immutable. Metadata used to create the destination Cloud SQL database.

542

"tier": "A String", # The tier (or machine type) for this instance, for example: `db-n1-standard-1` (MySQL instances) or `db-custom-1-3840` (PostgreSQL instances). For more information, see [Cloud SQL Instance Settings](https://cloud.google.com/sql/docs/mysql/instance-settings).

543

"storageAutoResizeLimit": "A String", # The maximum size to which storage capacity can be automatically increased. The default value is 0, which specifies that there is no limit.

544

"rootPassword": "A String", # Input only. Initial root password.

545

"userLabels": { # The resource labels for a Cloud SQL instance to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "18kg", "count": "3" }`.

546

"a_key": "A String",

547

},

548

"rootPasswordSet": True or False, # Output only. Indicates If this connection profile root password is stored.

549

"zone": "A String", # The Google Cloud Platform zone where your Cloud SQL datdabse instance is located.

550

"dataDiskType": "A String", # The type of storage: `PD_SSD` (default) or `PD_HDD`.

551

"databaseFlags": { # The database flags passed to the Cloud SQL instance at startup. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

552

"a_key": "A String",

553

},

554

"databaseVersion": "A String", # The database engine type and version (such as `MYSQL_5_7` / `POSTGRES_9_6`).

555

"dataDiskSizeGb": "A String", # The storage capacity available to the database, in GB. The minimum (and default) size is 10GB.

556

"autoStorageIncrease": True or False, # [default: ON] If you enable this setting, Cloud SQL checks your available storage every 30 seconds. If the available storage falls below a threshold size, Cloud SQL automatically adds additional storage capacity. If the available storage repeatedly falls below the threshold size, Cloud SQL continues to add storage until it reaches the maximum of 30 TB.

557

"activationPolicy": "A String", # The activation policy specifies when the instance is activated; it is applicable only when the instance state is 'RUNNABLE'. Valid values: 'ALWAYS': The instance is on, and remains so even in the absence of connection requests. `NEVER`: The instance is off; it is not activated, even if a connection request arrives.

558

"sourceId": "A String", # The Database Migration Service source connection profile ID, in the format: `projects/my_project_name/locations/us-central1/connectionProfiles/connection_profile_ID`

559

"ipConfig": { # IP Management configuration. # The settings for IP Management. This allows to enable or disable the instance IP and manage which external networks can connect to the instance. The IPv4 address cannot be disabled.

560

"privateNetwork": "A String", # The resource link for the VPC network from which the Cloud SQL instance is accessible for private IP. For example, `/projects/myProject/global/networks/default`. This setting can be updated, but it cannot be removed after it is set.

561

"authorizedNetworks": [ # The list of external networks that are allowed to connect to the instance using the IP. See https://en.wikipedia.org/wiki/CIDR_notation#CIDR_notation, also known as 'slash' notation (e.g. `192.168.100.0/24`).

562

{ # An entry for an Access Control list.

563

"ttl": "A String", # Input only. The time-to-leave of this access control entry.

564

"label": "A String", # A label to identify this entry.

565

"expireTime": "A String", # The time when this access control entry expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example: `2012-11-15T16:19:00.094Z`.

566

"value": "A String", # The allowlisted value for the access control list.

567

},

568

],

569

"requireSsl": True or False, # Whether SSL connections over IP should be enforced or not.

570

"enableIpv4": True or False, # Whether the instance should be assigned an IPv4 address or not.

571

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

572

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

573

"publicIp": "A String", # Output only. The Cloud SQL database instance's public IP.

574

"cloudSqlId": "A String", # Output only. The Cloud SQL instance ID that this connection profile is associated with.

575

"privateIp": "A String", # Output only. The Cloud SQL database instance's private IP.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

576

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

577

"labels": { # The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`.

578

"a_key": "A String",

579

},

580

"updateTime": "A String", # Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

581

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error details in case of state FAILED.

582

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

583

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

584

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

585

{

586

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

}

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

591

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

592

requestId: string, A unique id used to identify the request. If the server receives two requests with the same id, then the second request will be ignored. It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

593

updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the connection profile resource by the update.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

594

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

601

602

{ # This resource represents a long-running operation that is the result of a network API call.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

603

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

604

"a_key": "", # Properties of the object. Contains field @type with type URL.

605

},

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

606

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

607

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

608

"a_key": "", # Properties of the object. Contains field @type with type URL.

609

},

610

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

611

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

612

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

613

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

614

{

615

"a_key": "", # Properties of the object. Contains field @type with type URL.

616

},

617

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

618

},

619

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

}</pre>

</div>

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

625

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

626

627

Args:

628

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

629

body: object, The request body.

630

The object takes the form of:

631

632

{ # Request message for `SetIamPolicy` method.

633

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: `paths: "bindings, etag"`

634

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

635

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

636

{ # Associates `members` with a `role`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

637

"bindingId": "A String",

638

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

639

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

640

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

641

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

642

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

643

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

644

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

645

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

646

"A String",

647

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

648

},

649

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

650

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

651

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

652

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

653

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

654

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

655

"auditLogConfigs": [ # The configuration for logging of each type of permission.

656

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

657

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

658

"A String",

659

],

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

660

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

},

],

},

],

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

675

676

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

677

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

678

{ # Associates `members` with a `role`.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

679

"bindingId": "A String",

680

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

681

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

682

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

683

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

684

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

685

},

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

686

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

687

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

688

"A String",

689

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

690

},

691

],

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

692

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

693

"version": 42, # Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

694

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

695

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

696

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

697

"auditLogConfigs": [ # The configuration for logging of each type of permission.

698

{ # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

699

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

700

"A String",

701

],

Yoshi Automation Bot

c2228be

2020-11-24 15:48:03 -0800

[diff] [blame^]

702

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

673ec5c

2020-11-16 11:05:03 -0700

[diff] [blame]

},

],

},

],

}</pre>

</div>

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

712

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

713

714

Args:

715

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

716

body: object, The request body.

717

The object takes the form of:

718

719

{ # Request message for `TestIamPermissions` method.

720

"permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

"A String",

],

}

x__xgafv: string, V1 error format.

726

Allowed values

727