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

API calls for all endpoints tagged Projects.

Link to this section Summary

Link to this section Functions

Link to this function

clouderrorreporting_projects_delete_events(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_delete_events(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.DeleteEventsResponse.t()}
  | {:error, Tesla.Env.t()}

Deletes all error events of a given project.

Parameters

  • connection (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of projectName. Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

  • 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").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.DeleteEventsResponse{}} on success
  • {:error, info} on failure
Link to this function

clouderrorreporting_projects_events_list(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_events_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ListEventsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the specified events.

Parameters

  • connection (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of projectName. Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

  • 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").
    • :groupId (type: String.t) - Required. The group for which events shall be returned.
    • :pageSize (type: integer()) - Optional. The maximum number of results to return per response.
    • :pageToken (type: String.t) - Optional. A next_page_token provided by a previous response.
    • :"serviceFilter.resourceType" (type: String.t) - Optional. The exact value to match against ServiceContext.resource_type.
    • :"serviceFilter.service" (type: String.t) - Optional. The exact value to match against ServiceContext.service.
    • :"serviceFilter.version" (type: String.t) - Optional. The exact value to match against ServiceContext.version.
    • :"timeRange.period" (type: String.t) - Restricts the query to the specified time range.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudErrorReporting.V1beta1.Model.ListEventsResponse{}} on success
  • {:error, info} on failure
Link to this function

clouderrorreporting_projects_events_report(connection, projects_id, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_events_report(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudErrorReporting.V1beta1.Model.ReportErrorEventResponse.t()}
  | {:error, Tesla.Env.t()}

Report an individual error event.

This endpoint accepts either an OAuth token, or an API key for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:

POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456

Parameters

  • connection (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of projectName. Required. The resource name of the Google Cloud Platform project. Written as projects/{projectId}, where {projectId} is the Google Cloud Platform project ID.

    Example: // projects/my-project-123.

  • 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").
    • :body (type: GoogleApi.CloudErrorReporting.V1beta1.Model.ReportedErrorEvent.t) -
  • opts (type: keyword()) - Call options

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, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_group_stats_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ListGroupStatsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the specified groups.

Parameters

  • connection (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of projectName. Required. The resource name of the Google Cloud Platform project. Written as projects/{projectID}, where {projectID} is the Google Cloud Platform project ID.

    Example: projects/my-project-123.

  • 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").
    • :alignment (type: String.t) - Optional. The alignment of the timed counts to be returned. Default is ALIGNMENT_EQUAL_AT_END.
    • :alignmentTime (type: DateTime.t) - Optional. Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.
    • :groupId (type: list(String.t)) - Optional. List all ErrorGroupStats with these IDs.
    • :order (type: String.t) - Optional. The sort order in which the results are returned. Default is COUNT_DESC.
    • :pageSize (type: integer()) - Optional. The maximum number of results to return per response. Default is 20.
    • :pageToken (type: 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.
    • :"serviceFilter.resourceType" (type: String.t) - Optional. The exact value to match against ServiceContext.resource_type.
    • :"serviceFilter.service" (type: String.t) - Optional. The exact value to match against ServiceContext.service.
    • :"serviceFilter.version" (type: String.t) - Optional. The exact value to match against ServiceContext.version.
    • :"timeRange.period" (type: String.t) - Restricts the query to the specified time range.
    • :timedCountDuration (type: String.t) - Optional. The preferred duration for a single returned TimedCount. If not set, no timed counts are returned.
  • opts (type: keyword()) - Call options

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, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_groups_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup.t()}
  | {:error, Tesla.Env.t()}

Get the specified group.

Parameters

  • connection (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server

  • projects_id (type: String.t) - Part of groupName. Required. The group resource name. Written as projects/projectID/groups/group_name. Call groupStats.list to return a list of groups belonging to this project.

    Example: projects/my-project-123/groups/my-group

  • groups_id (type: String.t) - Part of groupName. See documentation of projectsId.

  • 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").
  • opts (type: keyword()) - Call options

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, optional_params \\ [], opts \\ [])

View Source
clouderrorreporting_projects_groups_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  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 (type: GoogleApi.CloudErrorReporting.V1beta1.Connection.t) - Connection to server
  • projects_id (type: String.t) - Part of group.name. The group resource name. Example: projects/my-project-123/groups/my-groupid
  • groups_id (type: String.t) - Part of group.name. See documentation of projectsId.
  • 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").
    • :body (type: GoogleApi.CloudErrorReporting.V1beta1.Model.ErrorGroup.t) -
  • opts (type: keyword()) - Call options

Returns

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