| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="dlp_v2.html">Sensitive Data Protection (DLP)</a> . <a href="dlp_v2.projects.html">projects</a> . <a href="dlp_v2.projects.locations.html">locations</a> . <a href="dlp_v2.projects.locations.projectDataProfiles.html">projectDataProfiles</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 |
<p class="firstline">Gets a project data profile.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 85 |
<p class="firstline">Lists project data profiles for an organization.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list_next">list_next()</a></code></p> |
| 88 |
<p class="firstline">Retrieves the next page of results.</p> |
| 89 |
<h3>Method Details</h3> |
| 90 |
<div class="method"> |
| 91 |
<code class="details" id="close">close()</code> |
| 92 |
<pre>Close httplib2 connections.</pre> |
| 93 |
</div> |
| 94 |
|
| 95 |
<div class="method"> |
| 96 |
<code class="details" id="get">get(name, x__xgafv=None)</code> |
| 97 |
<pre>Gets a project data profile. |
| 98 |
|
| 99 |
Args: |
| 100 |
name: string, Required. Resource name, for example `organizations/12345/locations/us/projectDataProfiles/53234423`. (required) |
| 101 |
x__xgafv: string, V1 error format. |
| 102 |
Allowed values |
| 103 |
1 - v1 error format |
| 104 |
2 - v2 error format |
| 105 |
|
| 106 |
Returns: |
| 107 |
An object of the form: |
| 108 |
|
| 109 |
{ # An aggregated profile for this project, based on the resources profiled within it. |
| 110 |
"dataRiskLevel": { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level of this project. |
| 111 |
"score": "A String", # The score applied to the resource. |
| 112 |
}, |
| 113 |
"fileStoreDataProfileCount": "A String", # The number of file store data profiles generated for this project. |
| 114 |
"name": "A String", # The resource name of the profile. |
| 115 |
"profileLastGenerated": "A String", # The last time the profile was generated. |
| 116 |
"profileStatus": { # Success or errors for the profile generation. # Success or error status of the last attempt to profile the project. |
| 117 |
"status": { # 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). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK. |
| 118 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 119 |
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 120 |
{ |
| 121 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 122 |
}, |
| 123 |
], |
| 124 |
"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. |
| 125 |
}, |
| 126 |
"timestamp": "A String", # Time when the profile generation status was updated |
| 127 |
}, |
| 128 |
"projectId": "A String", # Project ID or account that was profiled. |
| 129 |
"sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity score of this project. |
| 130 |
"score": "A String", # The sensitivity score applied to the resource. |
| 131 |
}, |
| 132 |
"tableDataProfileCount": "A String", # The number of table data profiles generated for this project. |
| 133 |
}</pre> |
| 134 |
</div> |
| 135 |
|
| 136 |
<div class="method"> |
| 137 |
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 138 |
<pre>Lists project data profiles for an organization. |
| 139 |
|
| 140 |
Args: |
| 141 |
parent: string, Required. organizations/{org_id}/locations/{loc_id} (required) |
| 142 |
filter: string, Allows filtering. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * Supported fields: - `project_id`: the Google Cloud project ID - `sensitivity_level`: HIGH|MODERATE|LOW - `data_risk_level`: HIGH|MODERATE|LOW - `status_code`: an RPC status code as defined in https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto - `profile_last_generated`: Date and time the profile was last generated * The operator must be `=` or `!=`. The `profile_last_generated` filter also supports `<` and `>`. The syntax is based on https://google.aip.dev/160. Examples: * `project_id = 12345 AND status_code = 1` * `project_id = 12345 AND sensitivity_level = HIGH` * `profile_last_generated < "2025-01-01T00:00:00.000Z"` The length of this field should be no more than 500 characters. |
| 143 |
orderBy: string, Comma-separated list of fields to order by, followed by `asc` or `desc` postfix. This list is case insensitive. The default sorting order is ascending. Redundant space characters are insignificant. Only one order field at a time is allowed. Examples: * `project_id` * `sensitivity_level desc` Supported fields: - `project_id`: Google Cloud project ID - `sensitivity_level`: How sensitive the data in a project is, at most - `data_risk_level`: How much risk is associated with this data - `profile_last_generated`: Date and time (in epoch seconds) the profile was last generated |
| 144 |
pageSize: integer, Size of the page. This value can be limited by the server. If zero, server returns a page of max size 100. |
| 145 |
pageToken: string, Page token to continue retrieval. |
| 146 |
x__xgafv: string, V1 error format. |
| 147 |
Allowed values |
| 148 |
1 - v1 error format |
| 149 |
2 - v2 error format |
| 150 |
|
| 151 |
Returns: |
| 152 |
An object of the form: |
| 153 |
|
| 154 |
{ # List of profiles generated for a given organization or project. |
| 155 |
"nextPageToken": "A String", # The next page token. |
| 156 |
"projectDataProfiles": [ # List of data profiles. |
| 157 |
{ # An aggregated profile for this project, based on the resources profiled within it. |
| 158 |
"dataRiskLevel": { # Score is a summary of all elements in the data profile. A higher number means more risk. # The data risk level of this project. |
| 159 |
"score": "A String", # The score applied to the resource. |
| 160 |
}, |
| 161 |
"fileStoreDataProfileCount": "A String", # The number of file store data profiles generated for this project. |
| 162 |
"name": "A String", # The resource name of the profile. |
| 163 |
"profileLastGenerated": "A String", # The last time the profile was generated. |
| 164 |
"profileStatus": { # Success or errors for the profile generation. # Success or error status of the last attempt to profile the project. |
| 165 |
"status": { # 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). # Profiling status code and optional message. The `status.code` value is 0 (default value) for OK. |
| 166 |
"code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 167 |
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. |
| 168 |
{ |
| 169 |
"a_key": "", # Properties of the object. Contains field @type with type URL. |
| 170 |
}, |
| 171 |
], |
| 172 |
"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. |
| 173 |
}, |
| 174 |
"timestamp": "A String", # Time when the profile generation status was updated |
| 175 |
}, |
| 176 |
"projectId": "A String", # Project ID or account that was profiled. |
| 177 |
"sensitivityScore": { # Score is calculated from of all elements in the data profile. A higher level means the data is more sensitive. # The sensitivity score of this project. |
| 178 |
"score": "A String", # The sensitivity score applied to the resource. |
| 179 |
}, |
| 180 |
"tableDataProfileCount": "A String", # The number of table data profiles generated for this project. |
| 181 |
}, |
| 182 |
], |
| 183 |
}</pre> |
| 184 |
</div> |
| 185 |
|
| 186 |
<div class="method"> |
| 187 |
<code class="details" id="list_next">list_next()</code> |
| 188 |
<pre>Retrieves the next page of results. |
| 189 |
|
| 190 |
Args: |
| 191 |
previous_request: The request for the previous page. (required) |
| 192 |
previous_response: The response from the request for the previous page. (required) |
| 193 |
|
| 194 |
Returns: |
| 195 |
A request object that you can call 'execute()' on to request the next |
| 196 |
page. Returns None if there are no more items in the collection. |
| 197 |
</pre> |
| 198 |
</div> |
| 199 |
|
| 200 |
</body></html> |