google_api_cloud_error_reporting v0.1.0 GoogleApi.CloudErrorReporting.V1beta1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

Report an individual error event. This endpoint accepts <strong>either</strong> an OAuth token, <strong>or</strong> an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>

Replace the data for the specified group. Fails if the group does not exist

Link to this section Functions

Link to this function clouderrorreporting_projects_delete_events(connection, projects_id, opts \\ []) View Source
clouderrorreporting_projects_delete_events(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.DeleteEventsResponse.t()}
  | {:error, Tesla.Env.t()}

Deletes all error events of a given project.

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `projectName`. [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the Google Cloud Platform project ID. Example: `projects/my-project-123`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.DeleteEventsResponse{}} on success {:error, info} on failure

Link to this function clouderrorreporting_projects_events_list(connection, projects_id, opts \\ []) View Source
clouderrorreporting_projects_events_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ListEventsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the specified events.

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `projectName`. [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the Google Cloud Platform project ID. Example: `projects/my-project-123`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :pageToken (String.t): [Optional] A `next_page_token` provided by a previous response.
    • :serviceFilter.service (String.t): [Optional] The exact value to match against `ServiceContext.service`.
    • :pageSize (integer()): [Optional] The maximum number of results to return per response.
    • :serviceFilter.version (String.t): [Optional] The exact value to match against `ServiceContext.version`.
    • :serviceFilter.resourceType (String.t): [Optional] The exact value to match against `ServiceContext.resource_type`.
    • :timeRange.period (String.t): Restricts the query to the specified time range.
    • :groupId (String.t): [Required] The group for which events shall be returned.

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ListEventsResponse{}} on success {:error, info} on failure

Link to this function clouderrorreporting_projects_events_report(connection, projects_id, opts \\ []) View Source
clouderrorreporting_projects_events_report(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudErrorReporting.V1beta1.Model.ReportErrorEventResponse.t()}
  | {:error, Tesla.Env.t()}

Report an individual error event. This endpoint accepts <strong>either</strong> an OAuth token, <strong>or</strong> an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: <pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `projectName`. [Required] The resource name of the Google Cloud Platform project. Written as `projects/` plus the Google Cloud Platform project ID. Example: `projects/my-project-123`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :body (ReportedErrorEvent):

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ReportErrorEventResponse{}} on success {:error, info} on failure

Link to this function clouderrorreporting_projects_group_stats_list(connection, projects_id, opts \\ []) View Source
clouderrorreporting_projects_group_stats_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ListGroupStatsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the specified groups.

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `projectName`. [Required] The resource name of the Google Cloud Platform project. Written as <code>projects/</code> plus the <a href="https://support.google.com/cloud/answer/6158840">Google Cloud Platform project ID</a>. Example: <code>projects/my-project-123</code>.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :timeRange.period (String.t): Restricts the query to the specified time range.
    • :alignment (String.t): [Optional] The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.
    • :groupId ([String.t]): [Optional] List all <code>ErrorGroupStats</code> with these IDs.
    • :serviceFilter.service (String.t): [Optional] The exact value to match against `ServiceContext.service`.
    • :pageSize (integer()): [Optional] The maximum number of results to return per response. Default is 20.
    • :serviceFilter.version (String.t): [Optional] The exact value to match against `ServiceContext.version`.
    • :order (String.t): [Optional] The sort order in which the results are returned. Default is `COUNT_DESC`.
    • :alignmentTime (DateTime.t): [Optional] Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
    • :serviceFilter.resourceType (String.t): [Optional] The exact value to match against `ServiceContext.resource_type`.
    • :timedCountDuration (String.t): [Optional] The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned.
    • :pageToken (String.t): [Optional] A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ListGroupStatsResponse{}} on success {:error, info} on failure

Link to this function clouderrorreporting_projects_groups_get(connection, projects_id, groups_id, opts \\ []) View Source
clouderrorreporting_projects_groups_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup.t()}
  | {:error, Tesla.Env.t()}

Get the specified group.

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `groupName`. [Required] The group resource name. Written as <code>projects/<var>projectID</var>/groups/<var>group_name</var></code>. Call <a href="/error-reporting/reference/rest/v1beta1/projects.groupStats/list"> <code>groupStats.list</code></a> to return a list of groups belonging to this project. Example: <code>projects/my-project-123/groups/my-group</code>
  • groups_id (String.t): Part of `groupName`. See documentation of `projectsId`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup{}} on success {:error, info} on failure

Link to this function clouderrorreporting_projects_groups_update(connection, projects_id, groups_id, opts \\ []) View Source
clouderrorreporting_projects_groups_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup.t()}
  | {:error, Tesla.Env.t()}

Replace the data for the specified group. Fails if the group does not exist.

Parameters

  • connection (GoogleApi.CloudErrorReporting.V1beta1.Connection): Connection to server
  • projects_id (String.t): Part of `group.name`. The group resource name. Example: <code>projects/my-project-123/groups/my-groupid</code>
  • groups_id (String.t): Part of `group.name`. See documentation of `projectsId`.
  • opts (KeywordList): [optional] Optional parameters

    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :callback (String.t): JSONP
    • :$.xgafv (String.t): V1 error format.
    • :alt (String.t): Data format for response.
    • :key (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.
    • :access_token (String.t): OAuth access token.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :bearer_token (String.t): OAuth bearer token.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :body (ErrorGroup):

Returns

{:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup{}} on success {:error, info} on failure