Documentation

Violation extends Message
in package

A message type used to describe a single quota violation. For example, a daily quota or a custom quota that was exceeded.

Generated from protobuf message google.rpc.QuotaFailure.Violation

Table of Contents

Properties

$description  : mixed
A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
$subject  : mixed
The subject on which the quota check failed.

Methods

__construct()  : mixed
Constructor.
getDescription()  : string
A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
getSubject()  : string
The subject on which the quota check failed.
setDescription()  : $this
A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.
setSubject()  : $this
The subject on which the quota check failed.

Properties

$description

A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

protected mixed $description = ''

For example: "Service disabled" or "Daily Limit for read operations exceeded".

Generated from protobuf field string description = 2 [json_name = "description"];

$subject

The subject on which the quota check failed.

protected mixed $subject = ''

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1 [json_name = "subject"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $subject
      The subject on which the quota check failed.
      For example, "clientip:<ip address of client>" or "project:<Google
      developer project id>".
@type string $description
      A description of how the quota check failed. Clients can use this
      description to find more about the quota configuration in the service's
      public documentation, or find the relevant quota limit to adjust through
      developer console.
      For example: "Service disabled" or "Daily Limit for read operations
      exceeded".

}

getDescription()

A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

public getDescription() : string

For example: "Service disabled" or "Daily Limit for read operations exceeded".

Generated from protobuf field string description = 2 [json_name = "description"];

Return values
string

getSubject()

The subject on which the quota check failed.

public getSubject() : string

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1 [json_name = "subject"];

Return values
string

setDescription()

A description of how the quota check failed. Clients can use this description to find more about the quota configuration in the service's public documentation, or find the relevant quota limit to adjust through developer console.

public setDescription(string $var) : $this

For example: "Service disabled" or "Daily Limit for read operations exceeded".

Generated from protobuf field string description = 2 [json_name = "description"];

Parameters
$var : string
Return values
$this

setSubject()

The subject on which the quota check failed.

public setSubject(string $var) : $this

For example, "clientip:" or "project:<Google developer project id>".

Generated from protobuf field string subject = 1 [json_name = "subject"];

Parameters
$var : string
Return values
$this

        
On this page

Search results