1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a> . <a href="datastream_v1.projects.locations.privateConnections.html">privateConnections</a> . <a href="datastream_v1.projects.locations.privateConnections.routes.html">routes</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="#create">create(parent, body=None, requestId=None, routeId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Use this method to create a route for a private connectivity in a project and location.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Use this method to delete a route.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Use this method to get details about a route.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Use this method to list routes created for a private connectivity in a project and location.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, requestId=None, routeId=None, x__xgafv=None)</code> 103 <pre>Use this method to create a route for a private connectivity in a project and location. 104 105Args: 106 parent: string, Required. The parent that owns the collection of Routes. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # The route resource is the child of the private connection resource, used for defining a route for a private connection. 111 "createTime": "A String", # Output only. The create time of the resource. 112 "destinationAddress": "A String", # Required. Destination address for connection 113 "destinationPort": 42, # Destination port for connection 114 "displayName": "A String", # Required. Display name. 115 "labels": { # Labels. 116 "a_key": "A String", 117 }, 118 "name": "A String", # Output only. The resource's name. 119 "updateTime": "A String", # Output only. The update time of the resource. 120} 121 122 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 123 routeId: string, Required. The Route identifier. 124 x__xgafv: string, V1 error format. 125 Allowed values 126 1 - v1 error format 127 2 - v2 error format 128 129Returns: 130 An object of the form: 131 132 { # This resource represents a long-running operation that is the result of a network API call. 133 "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. 134 "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. 135 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 136 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 137 { 138 "a_key": "", # Properties of the object. Contains field @type with type URL. 139 }, 140 ], 141 "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. 142 }, 143 "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. 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146 "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}`. 147 "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`. 148 "a_key": "", # Properties of the object. Contains field @type with type URL. 149 }, 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code> 155 <pre>Use this method to delete a route. 156 157Args: 158 name: string, Required. The name of the Route resource to delete. (required) 159 requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # This resource represents a long-running operation that is the result of a network API call. 169 "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. 170 "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. 171 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 172 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 173 { 174 "a_key": "", # Properties of the object. Contains field @type with type URL. 175 }, 176 ], 177 "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. 178 }, 179 "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. 180 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182 "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}`. 183 "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`. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="get">get(name, x__xgafv=None)</code> 191 <pre>Use this method to get details about a route. 192 193Args: 194 name: string, Required. The name of the Route resource to get. (required) 195 x__xgafv: string, V1 error format. 196 Allowed values 197 1 - v1 error format 198 2 - v2 error format 199 200Returns: 201 An object of the form: 202 203 { # The route resource is the child of the private connection resource, used for defining a route for a private connection. 204 "createTime": "A String", # Output only. The create time of the resource. 205 "destinationAddress": "A String", # Required. Destination address for connection 206 "destinationPort": 42, # Destination port for connection 207 "displayName": "A String", # Required. Display name. 208 "labels": { # Labels. 209 "a_key": "A String", 210 }, 211 "name": "A String", # Output only. The resource's name. 212 "updateTime": "A String", # Output only. The update time of the resource. 213}</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 218 <pre>Use this method to list routes created for a private connectivity in a project and location. 219 220Args: 221 parent: string, Required. The parent that owns the collection of Routess. (required) 222 filter: string, Filter request. 223 orderBy: string, Order by fields for the result. 224 pageSize: integer, Maximum number of Routes to return. The service may return fewer than this value. If unspecified, at most 50 Routes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. 225 pageToken: string, Page token received from a previous `ListRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRoutes` must match the call that provided the page token. 226 x__xgafv: string, V1 error format. 227 Allowed values 228 1 - v1 error format 229 2 - v2 error format 230 231Returns: 232 An object of the form: 233 234 { # Route list response. 235 "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. 236 "routes": [ # List of Routes. 237 { # The route resource is the child of the private connection resource, used for defining a route for a private connection. 238 "createTime": "A String", # Output only. The create time of the resource. 239 "destinationAddress": "A String", # Required. Destination address for connection 240 "destinationPort": 42, # Destination port for connection 241 "displayName": "A String", # Required. Display name. 242 "labels": { # Labels. 243 "a_key": "A String", 244 }, 245 "name": "A String", # Output only. The resource's name. 246 "updateTime": "A String", # Output only. The update time of the resource. 247 }, 248 ], 249 "unreachable": [ # Locations that could not be reached. 250 "A String", 251 ], 252}</pre> 253</div> 254 255<div class="method"> 256 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 257 <pre>Retrieves the next page of results. 258 259Args: 260 previous_request: The request for the previous page. (required) 261 previous_response: The response from the request for the previous page. (required) 262 263Returns: 264 A request object that you can call 'execute()' on to request the next 265 page. Returns None if there are no more items in the collection. 266 </pre> 267</div> 268 269</body></html>