1. class
  2. Google
  3. \
  4. Api
  5. \
  6. ResourceReference

ResourceReference

class ResourceReference extends Message

Defines a proto annotation that describes a string field that refers to an API resource.

Generated from protobuf message google.api.ResourceReference

Methods

__construct(array $data = NULL)

Constructor.

string
getType()

The resource type that the annotated field references.

$this
setType(string $var)

The resource type that the annotated field references.

string
getChildType()

The resource type of a child collection that the annotated field references. This is useful for annotating the parent field that doesn't have a fixed resource type.

$this
setChildType(string $var)

The resource type of a child collection that the annotated field references. This is useful for annotating the parent field that doesn't have a fixed resource type.

Details

at line 72
__construct(array $data = NULL)

Constructor.

Parameters

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

@type string $type
      The resource type that the annotated field references.
      Example:
          message Subscription {
            string topic = 2 [(google.api.resource_reference) = {
              type: "pubsub.googleapis.com/Topic"
            }];
          }
@type string $child_type
      The resource type of a child collection that the annotated field
      references. This is useful for annotating the `parent` field that
      doesn't have a fixed resource type.
      Example:
        message ListLogEntriesRequest {
          string parent = 1 [(google.api.resource_reference) = {
            child_type: "logging.googleapis.com/LogEntry"
          };
        }

}

at line 89
string getType()

The resource type that the annotated field references.

Example: message Subscription { string topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }

Generated from protobuf field string type = 1;

Return Value

string

at line 107
$this setType(string $var)

The resource type that the annotated field references.

Example: message Subscription { string topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }]; }

Generated from protobuf field string type = 1;

Parameters

string $var

Return Value

$this

at line 129
string getChildType()

The resource type of a child collection that the annotated field references. This is useful for annotating the parent field that doesn't have a fixed resource type.

Example: message ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type: "logging.googleapis.com/LogEntry" }; }

Generated from protobuf field string child_type = 2;

Return Value

string

at line 149
$this setChildType(string $var)

The resource type of a child collection that the annotated field references. This is useful for annotating the parent field that doesn't have a fixed resource type.

Example: message ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type: "logging.googleapis.com/LogEntry" }; }

Generated from protobuf field string child_type = 2;

Parameters

string $var

Return Value

$this