1. class
  2. Google
  3. \
  4. Rpc
  5. \
  6. ResourceInfo

ResourceInfo

class ResourceInfo extends Message

Describes the resource that is being accessed.

Generated from protobuf message google.rpc.ResourceInfo

Methods

__construct(array $data = NULL)

Constructor.

string
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".

$this
setResourceType(string $var)

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".

string
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][google.rpc.Code.PERMISSION_DENIED].

$this
setResourceName(string $var)

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][google.rpc.Code.PERMISSION_DENIED].

string
getOwner()

The owner of the resource (optional).

$this
setOwner(string $var)

The owner of the resource (optional).

string
getDescription()

Describes what error is encountered when accessing this resource.

$this
setDescription(string $var)

Describes what error is encountered when accessing this resource.

Details

at line 75
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $resource_type
      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".
@type string $resource_name
      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][google.rpc.Code.PERMISSION_DENIED].
@type string $owner
      The owner of the resource (optional).
      For example, "user:<owner email>" or "project:<Google developer project
      id>".
@type string $description
      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.

}

at line 88
string 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".

Generated from protobuf field string resource_type = 1;

Return Value

string

at line 102
$this setResourceType(string $var)

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".

Generated from protobuf field string resource_type = 1;

Parameters

string $var

Return Value

$this

at line 118
string 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][google.rpc.Code.PERMISSION_DENIED].

Generated from protobuf field string resource_name = 2;

Return Value

string

at line 132
$this setResourceName(string $var)

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][google.rpc.Code.PERMISSION_DENIED].

Generated from protobuf field string resource_name = 2;

Parameters

string $var

Return Value

$this

at line 148
string getOwner()

The owner of the resource (optional).

For example, "user:" or "project:".

Generated from protobuf field string owner = 3;

Return Value

string

at line 162
$this setOwner(string $var)

The owner of the resource (optional).

For example, "user:" or "project:".

Generated from protobuf field string owner = 3;

Parameters

string $var

Return Value

$this

at line 178
string 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.

Generated from protobuf field string description = 4;

Return Value

string

at line 192
$this setDescription(string $var)

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.

Generated from protobuf field string description = 4;

Parameters

string $var

Return Value

$this