Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create a Connection to an external data source.
Delete a Connection.
Get a Connection by name.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
Retrieves the next page of results.
patch(name, body=None, x__xgafv=None)
Update a Connection.
search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Searches for Connections in a parent.
Retrieves the next page of results.
close()
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
Create a Connection to an external data source.
Args:
parent: string, Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}` (required)
body: object, The request body.
The object takes the form of:
{ # Request message for CreateConnection.
"connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection resource.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A data connection to allow the DLP API to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
}
delete(name, x__xgafv=None)
Delete a Connection.
Args:
name: string, Required. Resource name of the Connection to be deleted, in the format: `projects/{project}/locations/{location}/connections/{connection}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Get a Connection by name.
Args:
name: string, Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A data connection to allow the DLP API to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
Args:
parent: string, Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required)
filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR
pageSize: integer, Optional. Number of results per page, max 1000.
pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ListConnections.
"connections": [ # List of connections.
{ # A data connection to allow the DLP API to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(name, body=None, x__xgafv=None)
Update a Connection.
Args:
name: string, Required. Resource name in the format: `projects/{project}/locations/{location}/connections/{connection}`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for UpdateConnection.
"connection": { # A data connection to allow the DLP API to profile data in locations that require additional configuration. # Required. The connection with new values for the relevant fields.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
},
"updateMask": "A String", # Optional. Mask to control which fields get updated.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A data connection to allow the DLP API to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
}
search(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Searches for Connections in a parent.
Args:
parent: string, Required. Resource name of the organization or project with a wildcard location, for example, `organizations/433245324/locations/-` or `projects/project-id/locations/-`. (required)
filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
pageSize: integer, Optional. Number of results per page, max 1000.
pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for SearchConnections.
"connections": [ # List of connections that match the search query. Note that only a subset of the fields will be populated, and only "name" is guaranteed to be set. For full details of a Connection, call GetConnection with the name.
{ # A data connection to allow the DLP API to profile data in locations that require additional configuration.
"cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
"cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
},
"connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
"databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
"maxConnections": 42, # Required. The DLP API will limit its connections to max_connections. Must be 2 or greater.
"usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
"passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
"username": "A String", # Required. The username.
},
},
"errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
{ # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
"details": { # 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). # Detailed error codes and messages.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"extraInfo": "A String", # Additional information about the error.
"timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
"A String",
],
},
],
"name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
"state": "A String", # Required. The connection's state in its lifecycle.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
}
search_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.