blob: 273639cce2923e54c8616e6ec15bfe106d9dd575 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="devicerun_v1alpha.html">Device Run API</a> . <a href="devicerun_v1alpha.projects.html">projects</a> . <a href="devicerun_v1alpha.projects.locations.html">locations</a> . <a href="devicerun_v1alpha.projects.locations.softwareVersions.html">softwareVersions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns information about a specific software version.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all software versions.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns information about a specific software version.
Args:
name: string, Required. The name of the software version. Format: `projects/{project}/locations/global/softwareVersions/{software_version}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single software version in the catalog.
&quot;androidxTestOrchestratorDetails&quot;: { # AndroidX Test Orchestrator-specific attributes. Reserved for future orchestrator-only fields. # Output only. Contains AndroidX Test Orchestrator-specific attributes (set when software_type == ANDROIDX_TEST_ORCHESTRATOR).
},
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Provides a human-readable name for this version, e.g. &quot;AndroidX Test Orchestrator 1.4.1&quot;.
&quot;isDefault&quot;: True or False, # Output only. Indicates whether the system uses this version when a request does not select one explicitly. Exactly one version per `software_type` is the default, and it may change over time.
&quot;lifecycle&quot;: { # Catalog resource lifecycle: maturity state plus key lifecycle dates. # Output only. The version lifecycle (maturity stage and removal date).
&quot;removalDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Specifies the date the resource is scheduled to be removed from the catalog. Only set when `state == DEPRECATED`.
&quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
&quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
&quot;state&quot;: &quot;A String&quot;, # Output only. Specifies the current maturity state of the resource.
},
&quot;name&quot;: &quot;A String&quot;, # Identifier. Identifies the software version resource. Format: `projects/{project}/locations/{location}/softwareVersions/{software_version}`. The {software_version} segment is an opaque, stable string. Clients must not parse it to derive or assume the version.
&quot;softwareType&quot;: &quot;A String&quot;, # Output only. Specifies which software this is a version of. Filter on this field to narrow the collection to a single kind of software, for example `software_type = &quot;ANDROIDX_TEST_ORCHESTRATOR&quot;`.
&quot;version&quot;: &quot;A String&quot;, # Output only. Specifies the version identifier, e.g. &quot;1.4.1&quot;. Unique within a `software_type`.
&quot;xcodeDetails&quot;: { # Xcode-specific attributes. # Output only. Contains Xcode-specific attributes (set when software_type == XCODE).
&quot;supportedIosVersions&quot;: [ # Output only. Lists the iOS versions this Xcode can run tests against, e.g. &quot;16.6&quot;. This is a property of the toolchain, so it says nothing about whether a device on that iOS version is available; list the `Device` collection to find out.
&quot;A String&quot;,
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all software versions.
Args:
parent: string, Required. The parent of the collection of software versions. Format: `projects/{project}/locations/global`. (required)
filter: string, Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which software versions are returned. An empty filter returns all software versions. Filtering is supported over the `SoftwareVersion` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `software_type = &quot;ANDROIDX_TEST_ORCHESTRATOR&quot;` * `software_type = &quot;ANDROIDX_TEST_ORCHESTRATOR&quot; AND is_default = true` * `lifecycle.state = &quot;ACTIVE&quot;` * `version = &quot;1.4.1&quot;`
pageSize: integer, Optional. The maximum number of software versions to return. The server may return fewer items than this value.
pageToken: string, Optional. A page token, received from a previous `ListSoftwareVersions` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListSoftwareVersions` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response including listed software versions.
&quot;nextPageToken&quot;: &quot;A String&quot;, # Token to receive the next page of software versions. This will be absent if the end of the response list has been reached.
&quot;softwareVersions&quot;: [ # The list of software versions.
{ # A single software version in the catalog.
&quot;androidxTestOrchestratorDetails&quot;: { # AndroidX Test Orchestrator-specific attributes. Reserved for future orchestrator-only fields. # Output only. Contains AndroidX Test Orchestrator-specific attributes (set when software_type == ANDROIDX_TEST_ORCHESTRATOR).
},
&quot;displayName&quot;: &quot;A String&quot;, # Output only. Provides a human-readable name for this version, e.g. &quot;AndroidX Test Orchestrator 1.4.1&quot;.
&quot;isDefault&quot;: True or False, # Output only. Indicates whether the system uses this version when a request does not select one explicitly. Exactly one version per `software_type` is the default, and it may change over time.
&quot;lifecycle&quot;: { # Catalog resource lifecycle: maturity state plus key lifecycle dates. # Output only. The version lifecycle (maturity stage and removal date).
&quot;removalDate&quot;: { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Output only. Specifies the date the resource is scheduled to be removed from the catalog. Only set when `state == DEPRECATED`.
&quot;day&quot;: 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#x27;t significant.
&quot;month&quot;: 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
&quot;year&quot;: 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
&quot;state&quot;: &quot;A String&quot;, # Output only. Specifies the current maturity state of the resource.
},
&quot;name&quot;: &quot;A String&quot;, # Identifier. Identifies the software version resource. Format: `projects/{project}/locations/{location}/softwareVersions/{software_version}`. The {software_version} segment is an opaque, stable string. Clients must not parse it to derive or assume the version.
&quot;softwareType&quot;: &quot;A String&quot;, # Output only. Specifies which software this is a version of. Filter on this field to narrow the collection to a single kind of software, for example `software_type = &quot;ANDROIDX_TEST_ORCHESTRATOR&quot;`.
&quot;version&quot;: &quot;A String&quot;, # Output only. Specifies the version identifier, e.g. &quot;1.4.1&quot;. Unique within a `software_type`.
&quot;xcodeDetails&quot;: { # Xcode-specific attributes. # Output only. Contains Xcode-specific attributes (set when software_type == XCODE).
&quot;supportedIosVersions&quot;: [ # Output only. Lists the iOS versions this Xcode can run tests against, e.g. &quot;16.6&quot;. This is a property of the toolchain, so it says nothing about whether a device on that iOS version is available; list the `Device` collection to find out.
&quot;A String&quot;,
],
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>