GoogleApi.ServiceControl.V1.Api.Services.servicecontrol_services_allocate_quota

You're seeing just the function servicecontrol_services_allocate_quota, go back to GoogleApi.ServiceControl.V1.Api.Services module for more information.
Link to this function

servicecontrol_services_allocate_quota(connection, service_name, optional_params \\ [], opts \\ [])

View Source

Specs

servicecontrol_services_allocate_quota(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.ServiceControl.V1.Model.AllocateQuotaResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Attempts to allocate quota for the specified consumer. It should be called before the operation is executed. This method requires the servicemanagement.services.quota permission on the specified service. For more information, see Cloud IAM. NOTE: The client must fail-open on server errors INTERNAL, UNKNOWN, DEADLINE_EXCEEDED, and UNAVAILABLE. To ensure system reliability, the server may inject these errors to prohibit any hard dependency on the quota functionality.

Parameters

  • connection (type: GoogleApi.ServiceControl.V1.Connection.t) - Connection to server
  • service_name (type: String.t) - Name of the service as specified in the service configuration. For example, "pubsub.googleapis.com". See google.api.Service for the definition of a service name.
  • 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.ServiceControl.V1.Model.AllocateQuotaRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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