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="compute_beta.html">Compute Engine API</a> . <a href="compute_beta.acceleratorTypes.html">acceleratorTypes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 79<p class="firstline">Retrieves an aggregated list of accelerator types.</p> 80<p class="toc_element"> 81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p> 82<p class="firstline">Retrieves the next page of results.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, zone, acceleratorType)</a></code></p> 85<p class="firstline">Returns the specified accelerator type. Get a list of available accelerator types by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 88<p class="firstline">Retrieves a list of accelerator types available to the specified project.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 95 <pre>Retrieves an aggregated list of accelerator types. 96 97Args: 98 project: string, Project ID for this request. (required) 99 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 100 101You 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. 102 103Currently, only sorting by name or creationTimestamp desc is supported. 104 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) 105 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. 106 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 107 108The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 109 110For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 111 112You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 113 114To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 115 116Returns: 117 An object of the form: 118 119 { 120 "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. 121 "items": { # [Output Only] A map of scoped accelerator type lists. 122 "a_key": { # [Output Only] Name of the scope containing this set of accelerator types. 123 "warning": { # [Output Only] An informational warning that appears when the accelerator types list is empty. 124 "message": "A String", # [Output Only] A human-readable description of the warning code. 125 "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. 126 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 127 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 128 { 129 "value": "A String", # [Output Only] A warning data value corresponding to the key. 130 "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). 131 }, 132 ], 133 }, 134 "acceleratorTypes": [ # [Output Only] List of accelerator types contained in this scope. 135 { # An Accelerator Type resource. 136 "kind": "compute#acceleratorType", # [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. 137 "description": "A String", # [Output Only] An optional textual description of the resource. 138 "zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. 139 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. 140 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 141 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 142 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 143 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 144 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 145 }, 146 "maximumCardsPerInstance": 42, # [Output Only] Maximum accelerator cards allowed per instance. 147 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 148 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 149 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 150 "name": "A String", # [Output Only] Name of the resource. 151 }, 152 ], 153 }, 154 }, 155 "kind": "compute#acceleratorTypeAggregatedList", # [Output Only] Type of resource. Always compute#acceleratorTypeAggregatedList for aggregated lists of accelerator types. 156 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 157 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 158 }</pre> 159</div> 160 161<div class="method"> 162 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 163 <pre>Retrieves the next page of results. 164 165Args: 166 previous_request: The request for the previous page. (required) 167 previous_response: The response from the request for the previous page. (required) 168 169Returns: 170 A request object that you can call 'execute()' on to request the next 171 page. Returns None if there are no more items in the collection. 172 </pre> 173</div> 174 175<div class="method"> 176 <code class="details" id="get">get(project, zone, acceleratorType)</code> 177 <pre>Returns the specified accelerator type. Get a list of available accelerator types by making a list() request. 178 179Args: 180 project: string, Project ID for this request. (required) 181 zone: string, The name of the zone for this request. (required) 182 acceleratorType: string, Name of the accelerator type to return. (required) 183 184Returns: 185 An object of the form: 186 187 { # An Accelerator Type resource. 188 "kind": "compute#acceleratorType", # [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. 189 "description": "A String", # [Output Only] An optional textual description of the resource. 190 "zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. 191 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. 192 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 193 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 194 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 195 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 196 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 197 }, 198 "maximumCardsPerInstance": 42, # [Output Only] Maximum accelerator cards allowed per instance. 199 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 200 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 201 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 202 "name": "A String", # [Output Only] Name of the resource. 203 }</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 208 <pre>Retrieves a list of accelerator types available to the specified project. 209 210Args: 211 project: string, Project ID for this request. (required) 212 zone: string, The name of the zone for this request. (required) 213 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 214 215You 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. 216 217Currently, only sorting by name or creationTimestamp desc is supported. 218 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) 219 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. 220 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 221 222The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 223 224For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 225 226You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 227 228To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 229 230Returns: 231 An object of the form: 232 233 { # Contains a list of accelerator types. 234 "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request. 235 "items": [ # A list of AcceleratorType resources. 236 { # An Accelerator Type resource. 237 "kind": "compute#acceleratorType", # [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. 238 "description": "A String", # [Output Only] An optional textual description of the resource. 239 "zone": "A String", # [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. 240 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this accelerator type. 241 "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it. 242 "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it. 243 "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error. 244 "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it. 245 "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. 246 }, 247 "maximumCardsPerInstance": 42, # [Output Only] Maximum accelerator cards allowed per instance. 248 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 249 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 250 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 251 "name": "A String", # [Output Only] Name of the resource. 252 }, 253 ], 254 "kind": "compute#acceleratorTypeList", # [Output Only] Type of resource. Always compute#acceleratorTypeList for lists of accelerator types. 255 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 256 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 257 }</pre> 258</div> 259 260<div class="method"> 261 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 262 <pre>Retrieves the next page of results. 263 264Args: 265 previous_request: The request for the previous page. (required) 266 previous_response: The response from the request for the previous page. (required) 267 268Returns: 269 A request object that you can call 'execute()' on to request the next 270 page. Returns None if there are no more items in the collection. 271 </pre> 272</div> 273 274</body></html>