Google API Common Protos Client - Class ResourceInfo (4.8.2)

Reference documentation and code samples for the Google API Common Protos Client class ResourceInfo.

Describes the resource that is being accessed.

Generated from protobuf message google.rpc.ResourceInfo

Namespace

Google \ Rpc

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ resource_type string

A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".

↳ resource_name string

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is google.rpc.Code.PERMISSION_DENIED.

↳ owner string

The owner of the resource (optional). For example, "user:

↳ description string

Describes what error is encountered when accessing this resource. For example, updating a cloud project may require the writer permission on the developer console project.

getResourceType

A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".

Returns
Type Description
string

setResourceType

A name for the type of resource being accessed, e.g. "sql table", "cloud storage bucket", "file", "Google calendar"; or the type URL of the resource: e.g. "type.googleapis.com/google.pubsub.v1.Topic".

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceName

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is google.rpc.Code.PERMISSION_DENIED.

Returns
Type Description
string

setResourceName

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh@group.calendar.google.com", if the current error is google.rpc.Code.PERMISSION_DENIED.

Parameter
Name Description
var string
Returns
Type Description
$this

getOwner

The owner of the resource (optional).

For example, "user:

Returns
Type Description
string

setOwner

The owner of the resource (optional).

For example, "user:

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

Describes what error is encountered when accessing this resource.

For example, updating a cloud project may require the writer permission on the developer console project.

Returns
Type Description
string

setDescription

Describes what error is encountered when accessing this resource.

For example, updating a cloud project may require the writer permission on the developer console project.

Parameter
Name Description
var string
Returns
Type Description
$this