Documentation

ResourceInfo extends Message
in package

Describes the resource that is being accessed.

Generated from protobuf message google.rpc.ResourceInfo

Table of Contents

Properties

$description  : mixed
Describes what error is encountered when accessing this resource.
$owner  : mixed
The owner of the resource (optional).
$resource_name  : mixed
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].
$resource_type  : mixed
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".

Methods

__construct()  : mixed
Constructor.
getDescription()  : string
Describes what error is encountered when accessing this resource.
getOwner()  : string
The owner of the resource (optional).
getResourceName()  : 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][google.rpc.Code.PERMISSION_DENIED].
getResourceType()  : 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".
setDescription()  : $this
Describes what error is encountered when accessing this resource.
setOwner()  : $this
The owner of the resource (optional).
setResourceName()  : $this
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].
setResourceType()  : $this
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".

Properties

$description

Describes what error is encountered when accessing this resource.

protected mixed $description = ''

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

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

$owner

The owner of the resource (optional).

protected mixed $owner = ''

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

Generated from protobuf field string owner = 3 [json_name = "owner"];

$resource_name

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh&#64;group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].

protected mixed $resource_name = ''

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

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

protected mixed $resource_type = ''

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

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 $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&#64;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.

}

getDescription()

Describes what error is encountered when accessing this resource.

public getDescription() : string

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

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

Return values
string

getOwner()

The owner of the resource (optional).

public getOwner() : string

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

Generated from protobuf field string owner = 3 [json_name = "owner"];

Return values
string

getResourceName()

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh&#64;group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].

public getResourceName() : string

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

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

public getResourceType() : string

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

Return values
string

setDescription()

Describes what error is encountered when accessing this resource.

public setDescription(string $var) : $this

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

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

Parameters
$var : string
Return values
$this

setOwner()

The owner of the resource (optional).

public setOwner(string $var) : $this

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

Generated from protobuf field string owner = 3 [json_name = "owner"];

Parameters
$var : string
Return values
$this

setResourceName()

The name of the resource being accessed. For example, a shared calendar name: "example.com_4fghdhgsrgh&#64;group.calendar.google.com", if the current error is [google.rpc.Code.PERMISSION_DENIED][google.rpc.Code.PERMISSION_DENIED].

public setResourceName(string $var) : $this

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

Parameters
$var : string
Return values
$this

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

public setResourceType(string $var) : $this

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

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results