Documentation

Help extends Message
in package

Provides links to documentation or for performing an out of band action.

For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.

Generated from protobuf message google.rpc.Help

Table of Contents

Properties

$links  : mixed
URL(s) pointing to additional information on handling the current error.

Methods

__construct()  : mixed
Constructor.
getLinks()  : RepeatedField
URL(s) pointing to additional information on handling the current error.
setLinks()  : $this
URL(s) pointing to additional information on handling the current error.

Properties

URL(s) pointing to additional information on handling the current error.

private mixed $links

Generated from protobuf field repeated .google.rpc.Help.Link links = 1 [json_name = "links"];

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 array<\Google\Rpc\Help\Link>|\Google\Protobuf\Internal\RepeatedField $links
      URL(s) pointing to additional information on handling the current error.

}

URL(s) pointing to additional information on handling the current error.

public getLinks() : RepeatedField

Generated from protobuf field repeated .google.rpc.Help.Link links = 1 [json_name = "links"];

Return values
RepeatedField

URL(s) pointing to additional information on handling the current error.

public setLinks(array<string|int, Link>|RepeatedField $var) : $this

Generated from protobuf field repeated .google.rpc.Help.Link links = 1 [json_name = "links"];

Parameters
$var : array<string|int, Link>|RepeatedField
Return values
$this

        
On this page

Search results