| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 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="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.interconnectLocations.html">interconnectLocations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#get">get(project, interconnectLocation)</a></code></p> |
| 79 | <p class="firstline">Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request.</p> |
| 80 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 81 | <code><a href="#list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 82 | <p class="firstline">Retrieves the list of interconnect locations available to the specified project.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 85 | <p class="firstline">Retrieves the next page of results.</p> |
| 86 | <h3>Method Details</h3> |
| 87 | <div class="method"> |
| 88 | <code class="details" id="get">get(project, interconnectLocation)</code> |
| 89 | <pre>Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. |
| 90 | |
| 91 | Args: |
| 92 | project: string, Project ID for this request. (required) |
| 93 | interconnectLocation: string, Name of the interconnect location to return. (required) |
| 94 | |
| 95 | Returns: |
| 96 | An object of the form: |
| 97 | |
| 98 | { # Represents an Interconnect Attachment (VLAN) Location resource. |
| 99 | # |
| 100 | # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 101 | "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. |
| 102 | "availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". |
| 103 | "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". |
| 104 | "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | # - AFRICA |
| 106 | # - ASIA_PAC |
| 107 | # - EUROPE |
| 108 | # - NORTH_AMERICA |
| 109 | # - SOUTH_AMERICA |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 110 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 111 | "description": "A String", # [Output Only] An optional description of the resource. |
| 112 | "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX). |
| 113 | "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). |
| 114 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 115 | "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. |
| 116 | "name": "A String", # [Output Only] Name of the resource. |
| 117 | "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). |
| 118 | "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. |
| 119 | { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. |
| 120 | "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. |
| 121 | "locationPresence": "A String", # Identifies the network presence of this location. |
| 122 | "region": "A String", # URL for the region of this location. |
| 123 | }, |
| 124 | ], |
| 125 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 126 | "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: |
| 127 | # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. |
| 128 | # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 129 | }</pre> |
| 130 | </div> |
| 131 | |
| 132 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 133 | <code class="details" id="list">list(project, filter=None, maxResults=None, orderBy=None, pageToken=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 134 | <pre>Retrieves the list of interconnect locations available to the specified project. |
| 135 | |
| 136 | Args: |
| 137 | project: string, Project ID for this request. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 138 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 139 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 140 | For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 141 | |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 142 | You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` |
| 145 | maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) |
| 146 | orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. |
| 147 | |
| 148 | You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. |
| 149 | |
| 150 | Currently, only sorting by `name` or `creationTimestamp desc` is supported. |
| 151 | pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 152 | |
| 153 | Returns: |
| 154 | An object of the form: |
| 155 | |
| 156 | { # Response to the list request, and contains a list of interconnect locations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 158 | "items": [ # A list of InterconnectLocation resources. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 159 | { # Represents an Interconnect Attachment (VLAN) Location resource. |
| 160 | # |
| 161 | # You can use this resource to find location details about an Interconnect attachment (VLAN). For more information about interconnect attachments, read Creating VLAN Attachments. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 162 | "address": "A String", # [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. |
| 163 | "availabilityZone": "A String", # [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". |
| 164 | "city": "A String", # [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". |
| 165 | "continent": "A String", # [Output Only] Continent for this location, which can take one of the following values: |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 166 | # - AFRICA |
| 167 | # - ASIA_PAC |
| 168 | # - EUROPE |
| 169 | # - NORTH_AMERICA |
| 170 | # - SOUTH_AMERICA |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| 172 | "description": "A String", # [Output Only] An optional description of the resource. |
| 173 | "facilityProvider": "A String", # [Output Only] The name of the provider for this facility (e.g., EQUINIX). |
| 174 | "facilityProviderFacilityId": "A String", # [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). |
| 175 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 176 | "kind": "compute#interconnectLocation", # [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. |
| 177 | "name": "A String", # [Output Only] Name of the resource. |
| 178 | "peeringdbFacilityId": "A String", # [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). |
| 179 | "regionInfos": [ # [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. |
| 180 | { # Information about any potential InterconnectAttachments between an Interconnect at a specific InterconnectLocation, and a specific Cloud Region. |
| 181 | "expectedRttMs": "A String", # Expected round-trip time in milliseconds, from this InterconnectLocation to a VM in this region. |
| 182 | "locationPresence": "A String", # Identifies the network presence of this location. |
| 183 | "region": "A String", # URL for the region of this location. |
| 184 | }, |
| 185 | ], |
| 186 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 187 | "status": "A String", # [Output Only] The status of this InterconnectLocation, which can take one of the following values: |
| 188 | # - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. |
| 189 | # - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 190 | }, |
| 191 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 192 | "kind": "compute#interconnectLocationList", # [Output Only] Type of resource. Always compute#interconnectLocationList for lists of interconnect locations. |
| 193 | "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| 194 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 195 | "warning": { # [Output Only] Informational warning message. |
| 196 | "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| 197 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| 198 | # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 199 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 200 | "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). |
| 201 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 202 | }, |
| 203 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 204 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 205 | }, |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 206 | }</pre> |
| 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| 210 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 211 | <pre>Retrieves the next page of results. |
| 212 | |
| 213 | Args: |
| 214 | previous_request: The request for the previous page. (required) |
| 215 | previous_response: The response from the request for the previous page. (required) |
| 216 | |
| 217 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 218 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 219 | page. Returns None if there are no more items in the collection. |
| 220 | </pre> |
| 221 | </div> |
| 222 | |
| 223 | </body></html> |