View Source GoogleApi.VersionHistory.V1.Api.Platforms (google_api_version_history v0.4.0)

API calls for all endpoints tagged Platforms.

Summary

Functions

Returns list of channels that are available for a given platform.

Returns list of platforms that are available for a given product. The resource "product" has no resource name in its name.

Functions

Link to this function

versionhistory_platforms_channels_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec versionhistory_platforms_channels_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VersionHistory.V1.Model.ListChannelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns list of channels that are available for a given platform.

Parameters

  • connection (type: GoogleApi.VersionHistory.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The platform, which owns this collection of channels. Format: {product}/platforms/{platform}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Optional limit on the number of channels to include in the response. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListChannels call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VersionHistory.V1.Model.ListChannelsResponse{}} on success
  • {:error, info} on failure
Link to this function

versionhistory_platforms_channels_versions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec versionhistory_platforms_channels_versions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VersionHistory.V1.Model.ListVersionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns list of version for the given platform/channel.

Parameters

  • connection (type: GoogleApi.VersionHistory.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The channel, which owns this collection of versions. Format: {product}/platforms/{platform}/channels/{channel}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter string. Format is a comma separated list of All comma separated filter clauses are conjoined with a logical "and". Valid field_names are "version", "name", "platform", and "channel". Valid operators are "<", "<=", "=", ">=", and ">". Channel comparison is done by distance from stable. Ex) stable < beta, beta < dev, canary < canary_asan. Version comparison is done numerically. If version is not entirely written, the version will be appended with 0 in missing fields. Ex) version > 80 becoms version > 80.0.0.0 Name and platform are filtered by string comparison. Ex) "...?filter=channel<=beta, version >= 80 Ex) "...?filter=version > 80, version < 81
    • :orderBy (type: String.t) - Optional. Ordering string. Valid order_by strings are "version", "name", "platform", and "channel". Optionally, you can append " desc" or " asc" to specify the sorting order. Multiple order_by strings can be used in a comma separated list. Ordering by channel will sort by distance from the stable channel (not alphabetically). A list of channels sorted in this order is: stable, beta, dev, canary, and canary_asan. Sorting by name may cause unexpected behaviour as it is a naive string sort. For example, 1.0.0.8 will be before 1.0.0.10 in descending order. If order_by is not specified the response will be sorted by version in descending order. Ex) "...?order_by=version asc" Ex) "...?order_by=platform desc, channel, version"
    • :pageSize (type: integer()) - Optional. Optional limit on the number of versions to include in the response. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListVersions call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VersionHistory.V1.Model.ListVersionsResponse{}} on success
  • {:error, info} on failure
Link to this function

versionhistory_platforms_channels_versions_releases_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec versionhistory_platforms_channels_versions_releases_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VersionHistory.V1.Model.ListReleasesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns list of releases of the given version.

Parameters

  • connection (type: GoogleApi.VersionHistory.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The version, which owns this collection of releases. Format: {product}/platforms/{platform}/channels/{channel}/versions/{version}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Optional. Filter string. Format is a comma separated list of All comma separated filter clauses are conjoined with a logical "and". Valid field_names are "version", "name", "platform", "channel", "fraction" "starttime", and "endtime". Valid operators are "<", "<=", "=", ">=", and ">". Channel comparison is done by distance from stable. must be a valid channel when filtering by channel. Ex) stable < beta, beta < dev, canary < canary_asan. Version comparison is done numerically. Ex) 1.0.0.8 < 1.0.0.10. If version is not entirely written, the version will be appended with 0 for the missing fields. Ex) version > 80 becoms version > 80.0.0.0 When filtering by starttime or endtime, string must be in RFC 3339 date string format. Name and platform are filtered by string comparison. Ex) "...?filter=channel<=beta, version >= 80 Ex) "...?filter=version > 80, version < 81 Ex) "...?filter=starttime>2020-01-01T00:00:00Z
    • :orderBy (type: String.t) - Optional. Ordering string. Valid order_by strings are "version", "name", "starttime", "endtime", "platform", "channel", and "fraction". Optionally, you can append "desc" or "asc" to specify the sorting order. Multiple order_by strings can be used in a comma separated list. Ordering by channel will sort by distance from the stable channel (not alphabetically). A list of channels sorted in this order is: stable, beta, dev, canary, and canary_asan. Sorting by name may cause unexpected behaviour as it is a naive string sort. For example, 1.0.0.8 will be before 1.0.0.10 in descending order. If order_by is not specified the response will be sorted by starttime in descending order. Ex) "...?order_by=starttime asc" Ex) "...?order_by=platform desc, channel, startime desc"
    • :pageSize (type: integer()) - Optional. Optional limit on the number of releases to include in the response. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListReleases call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VersionHistory.V1.Model.ListReleasesResponse{}} on success
  • {:error, info} on failure
Link to this function

versionhistory_platforms_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec versionhistory_platforms_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.VersionHistory.V1.Model.ListPlatformsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Returns list of platforms that are available for a given product. The resource "product" has no resource name in its name.

Parameters

  • connection (type: GoogleApi.VersionHistory.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The product, which owns this collection of platforms. Format: {product}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Optional. Optional limit on the number of channels to include in the response. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListChannels call. Provide this to retrieve the subsequent page.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.VersionHistory.V1.Model.ListPlatformsResponse{}} on success
  • {:error, info} on failure