code
stringlengths 17
296k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function setBuiltIn($var)
{
GPBUtil::checkBool($var);
$this->built_in = $var;
return $this;
} | Output only. Whether the `Role` is a built-in or custom user role.
Generated from protobuf field <code>bool built_in = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param bool $var
@return $this | setBuiltIn | php | googleapis/google-cloud-php | AdsAdManager/src/V1/Role.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/Role.php | Apache-2.0 |
public function getStatus()
{
return $this->status;
} | Output only. The status of the `Role`.
Generated from protobuf field <code>.google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getStatus | php | googleapis/google-cloud-php | AdsAdManager/src/V1/Role.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/Role.php | Apache-2.0 |
public function setStatus($var)
{
GPBUtil::checkEnum($var, \Google\Ads\AdManager\V1\RoleStatusEnum\RoleStatus::class);
$this->status = $var;
return $this;
} | Output only. The status of the `Role`.
Generated from protobuf field <code>.google.ads.admanager.v1.RoleStatusEnum.RoleStatus status = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setStatus | php | googleapis/google-cloud-php | AdsAdManager/src/V1/Role.php | https://github.com/googleapis/google-cloud-php/blob/master/AdsAdManager/src/V1/Role.php | Apache-2.0 |
public function getOperations()
{
return $this->operations;
} | The list of matching instance configuration long-running operations. Each
operation's name will be
prefixed by the name of the instance configuration. The operation's
metadata field type
`metadata.type_url` describes the type of the metadata.
Generated from protobuf field <code>repeated .google.longrunning.Operation operations = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getOperations | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | Apache-2.0 |
public function setOperations($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\LongRunning\Operation::class);
$this->operations = $arr;
return $this;
} | The list of matching instance configuration long-running operations. Each
operation's name will be
prefixed by the name of the instance configuration. The operation's
metadata field type
`metadata.type_url` describes the type of the metadata.
Generated from protobuf field <code>repeated .google.longrunning.Operation operations = 1;</code>
@param array<\Google\LongRunning\Operation>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setOperations | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | `next_page_token` can be sent in a subsequent
[ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations]
call to fetch more of the matching metadata.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | `next_page_token` can be sent in a subsequent
[ListInstanceConfigOperations][google.spanner.admin.instance.v1.InstanceAdmin.ListInstanceConfigOperations]
call to fetch more of the matching metadata.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/Admin/Instance/V1/ListInstanceConfigOperationsResponse.php | Apache-2.0 |
public function getDuration()
{
return $this->duration;
} | Duration for which the stream should be muted. If omitted, the stream
will be muted until an UnmuteTask event is sent.
Generated from protobuf field <code>.google.protobuf.Duration duration = 1;</code>
@return \Google\Protobuf\Duration|null | getDuration | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Event/MuteTask.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Event/MuteTask.php | Apache-2.0 |
public function setDuration($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Duration::class);
$this->duration = $var;
return $this;
} | Duration for which the stream should be muted. If omitted, the stream
will be muted until an UnmuteTask event is sent.
Generated from protobuf field <code>.google.protobuf.Duration duration = 1;</code>
@param \Google\Protobuf\Duration $var
@return $this | setDuration | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Event/MuteTask.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Event/MuteTask.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The relative resource name of the location in which to create a
federation service, in the following form:
`projects/{project_number}/locations/{location_id}`.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getParent | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The relative resource name of the location in which to create a
federation service, in the following form:
`projects/{project_number}/locations/{location_id}`.
Generated from protobuf field <code>string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setParent | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function getFederationId()
{
return $this->federation_id;
} | Required. The ID of the metastore federation, which is used as the final
component of the metastore federation's name.
This value must be between 2 and 63 characters long inclusive, begin with a
letter, end with a letter or number, and consist of alpha-numeric
ASCII characters or hyphens.
Generated from protobuf field <code>string federation_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getFederationId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function setFederationId($var)
{
GPBUtil::checkString($var, True);
$this->federation_id = $var;
return $this;
} | Required. The ID of the metastore federation, which is used as the final
component of the metastore federation's name.
This value must be between 2 and 63 characters long inclusive, begin with a
letter, end with a letter or number, and consist of alpha-numeric
ASCII characters or hyphens.
Generated from protobuf field <code>string federation_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setFederationId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function getFederation()
{
return $this->federation;
} | Required. The Metastore Federation to create. The `name` field is
ignored. The ID of the created metastore federation must be
provided in the request's `federation_id` field.
Generated from protobuf field <code>.google.cloud.metastore.v1beta.Federation federation = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Metastore\V1beta\Federation|null | getFederation | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function setFederation($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Metastore\V1beta\Federation::class);
$this->federation = $var;
return $this;
} | Required. The Metastore Federation to create. The `name` field is
ignored. The ID of the created metastore federation must be
provided in the request's `federation_id` field.
Generated from protobuf field <code>.google.cloud.metastore.v1beta.Federation federation = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Metastore\V1beta\Federation $var
@return $this | setFederation | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request
with the same request ID, the server ignores the second request to prevent
the creation of duplicate commitments.
The request ID must be a valid
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. A request ID. Specify a unique request ID to allow the server to
ignore the request if it has completed. The server will ignore subsequent
requests that provide a duplicate request ID for at least 60 minutes after
the first request.
For example, if an initial request times out, followed by another request
with the same request ID, the server ignores the second request to prevent
the creation of duplicate commitments.
The request ID must be a valid
[UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier#Format)
A zero UUID (00000000-0000-0000-0000-000000000000) is not supported.
Generated from protobuf field <code>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | DataprocMetastore/src/V1beta/CreateFederationRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataprocMetastore/src/V1beta/CreateFederationRequest.php | Apache-2.0 |
public function getChatEngineConfig()
{
return $this->readOneof(11);
} | Configurations for the Chat Engine. Only applicable if
[solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;</code>
@return \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig|null | getChatEngineConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setChatEngineConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig::class);
$this->writeOneof(11, $var);
return $this;
} | Configurations for the Chat Engine. Only applicable if
[solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.ChatEngineConfig chat_engine_config = 11;</code>
@param \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig $var
@return $this | setChatEngineConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getSearchEngineConfig()
{
return $this->readOneof(13);
} | Configurations for the Search Engine. Only applicable if
[solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;</code>
@return \Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig|null | getSearchEngineConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setSearchEngineConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig::class);
$this->writeOneof(13, $var);
return $this;
} | Configurations for the Search Engine. Only applicable if
[solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.SearchEngineConfig search_engine_config = 13;</code>
@param \Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig $var
@return $this | setSearchEngineConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getChatEngineMetadata()
{
return $this->readOneof(12);
} | Output only. Additional information of the Chat Engine. Only applicable
if [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type]
is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata|null | getChatEngineMetadata | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setChatEngineMetadata($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata::class);
$this->writeOneof(12, $var);
return $this;
} | Output only. Additional information of the Chat Engine. Only applicable
if [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type]
is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata chat_engine_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineMetadata $var
@return $this | setChatEngineMetadata | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
engine should be 1-63 characters, and valid characters are
/[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>
@return string | getName | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Immutable. The fully qualified resource name of the engine.
This field must be a UTF-8 encoded string with a length limit of 1024
characters.
Format:
`projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
engine should be 1-63 characters, and valid characters are
/[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IMMUTABLE];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getDisplayName()
{
return $this->display_name;
} | Required. The display name of the engine. Should be human readable. UTF-8
encoded string with limit of 1024 characters.
Generated from protobuf field <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getDisplayName | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
} | Required. The display name of the engine. Should be human readable. UTF-8
encoded string with limit of 1024 characters.
Generated from protobuf field <code>string display_name = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setDisplayName | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getCreateTime()
{
return $this->create_time;
} | Output only. Timestamp the Recommendation Engine was created at.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. Timestamp the Recommendation Engine was created at.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getUpdateTime()
{
return $this->update_time;
} | Output only. Timestamp the Recommendation Engine was last updated.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getUpdateTime | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setUpdateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->update_time = $var;
return $this;
} | Output only. Timestamp the Recommendation Engine was last updated.
Generated from protobuf field <code>.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setUpdateTime | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getDataStoreIds()
{
return $this->data_store_ids;
} | The data stores associated with this engine.
For
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]
and
[SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
type of engines, they can only associate with at most one data store.
If [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT],
multiple [DataStore][google.cloud.discoveryengine.v1.DataStore]s in the
same [Collection][google.cloud.discoveryengine.v1.Collection] can be
associated here.
Note that when used in
[CreateEngineRequest][google.cloud.discoveryengine.v1.CreateEngineRequest],
one DataStore id must be provided as the system will use it for necessary
initializations.
Generated from protobuf field <code>repeated string data_store_ids = 5;</code>
@return \Google\Protobuf\Internal\RepeatedField | getDataStoreIds | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setDataStoreIds($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->data_store_ids = $arr;
return $this;
} | The data stores associated with this engine.
For
[SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH]
and
[SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
type of engines, they can only associate with at most one data store.
If [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is
[SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT],
multiple [DataStore][google.cloud.discoveryengine.v1.DataStore]s in the
same [Collection][google.cloud.discoveryengine.v1.Collection] can be
associated here.
Note that when used in
[CreateEngineRequest][google.cloud.discoveryengine.v1.CreateEngineRequest],
one DataStore id must be provided as the system will use it for necessary
initializations.
Generated from protobuf field <code>repeated string data_store_ids = 5;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setDataStoreIds | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getSolutionType()
{
return $this->solution_type;
} | Required. The solutions of the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];</code>
@return int | getSolutionType | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setSolutionType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\SolutionType::class);
$this->solution_type = $var;
return $this;
} | Required. The solutions of the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.SolutionType solution_type = 6 [(.google.api.field_behavior) = REQUIRED];</code>
@param int $var
@return $this | setSolutionType | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getIndustryVertical()
{
return $this->industry_vertical;
} | The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
[DataStore][google.cloud.discoveryengine.v1.DataStore]: Vertical on Engine
has to match vertical of the DataStore linked to the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;</code>
@return int | getIndustryVertical | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setIndustryVertical($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\DiscoveryEngine\V1\IndustryVertical::class);
$this->industry_vertical = $var;
return $this;
} | The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
[DataStore][google.cloud.discoveryengine.v1.DataStore]: Vertical on Engine
has to match vertical of the DataStore linked to the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 16;</code>
@param int $var
@return $this | setIndustryVertical | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getCommonConfig()
{
return $this->common_config;
} | Common config spec that specifies the metadata of the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;</code>
@return \Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig|null | getCommonConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setCommonConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig::class);
$this->common_config = $var;
return $this;
} | Common config spec that specifies the metadata of the engine.
Generated from protobuf field <code>.google.cloud.discoveryengine.v1.Engine.CommonConfig common_config = 15;</code>
@param \Google\Cloud\DiscoveryEngine\V1\Engine\CommonConfig $var
@return $this | setCommonConfig | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getDisableAnalytics()
{
return $this->disable_analytics;
} | Optional. Whether to disable analytics for searches performed on this
engine.
Generated from protobuf field <code>bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];</code>
@return bool | getDisableAnalytics | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function setDisableAnalytics($var)
{
GPBUtil::checkBool($var);
$this->disable_analytics = $var;
return $this;
} | Optional. Whether to disable analytics for searches performed on this
engine.
Generated from protobuf field <code>bool disable_analytics = 26 [(.google.api.field_behavior) = OPTIONAL];</code>
@param bool $var
@return $this | setDisableAnalytics | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/Engine.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/Engine.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. Name of the resource.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getName | php | googleapis/google-cloud-php | BareMetalSolution/src/V2/GetNfsShareRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/BareMetalSolution/src/V2/GetNfsShareRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. Name of the resource.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | BareMetalSolution/src/V2/GetNfsShareRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/BareMetalSolution/src/V2/GetNfsShareRequest.php | Apache-2.0 |
public function getPrediction()
{
return isset($this->prediction) ? $this->prediction : '';
} | Required. Output of the evaluated model.
Generated from protobuf field <code>optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getPrediction | php | googleapis/google-cloud-php | AiPlatform/src/V1/ToolNameMatchInstance.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ToolNameMatchInstance.php | Apache-2.0 |
public function setPrediction($var)
{
GPBUtil::checkString($var, True);
$this->prediction = $var;
return $this;
} | Required. Output of the evaluated model.
Generated from protobuf field <code>optional string prediction = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setPrediction | php | googleapis/google-cloud-php | AiPlatform/src/V1/ToolNameMatchInstance.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ToolNameMatchInstance.php | Apache-2.0 |
public function getReference()
{
return isset($this->reference) ? $this->reference : '';
} | Required. Ground truth used to compare against the prediction.
Generated from protobuf field <code>optional string reference = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/ToolNameMatchInstance.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ToolNameMatchInstance.php | Apache-2.0 |
public function setReference($var)
{
GPBUtil::checkString($var, True);
$this->reference = $var;
return $this;
} | Required. Ground truth used to compare against the prediction.
Generated from protobuf field <code>optional string reference = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setReference | php | googleapis/google-cloud-php | AiPlatform/src/V1/ToolNameMatchInstance.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/ToolNameMatchInstance.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | Required. Mask of fields to update. At least one path must be supplied in
this field.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | Filestore/src/V1/UpdateSnapshotRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Filestore/src/V1/UpdateSnapshotRequest.php | Apache-2.0 |
public function setUpdateMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->update_mask = $var;
return $this;
} | Required. Mask of fields to update. At least one path must be supplied in
this field.
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setUpdateMask | php | googleapis/google-cloud-php | Filestore/src/V1/UpdateSnapshotRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Filestore/src/V1/UpdateSnapshotRequest.php | Apache-2.0 |
public function getSnapshot()
{
return $this->snapshot;
} | Required. A snapshot resource.
Generated from protobuf field <code>.google.cloud.filestore.v1.Snapshot snapshot = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Filestore\V1\Snapshot|null | getSnapshot | php | googleapis/google-cloud-php | Filestore/src/V1/UpdateSnapshotRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Filestore/src/V1/UpdateSnapshotRequest.php | Apache-2.0 |
public function setSnapshot($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Filestore\V1\Snapshot::class);
$this->snapshot = $var;
return $this;
} | Required. A snapshot resource.
Generated from protobuf field <code>.google.cloud.filestore.v1.Snapshot snapshot = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Filestore\V1\Snapshot $var
@return $this | setSnapshot | php | googleapis/google-cloud-php | Filestore/src/V1/UpdateSnapshotRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Filestore/src/V1/UpdateSnapshotRequest.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Optional. Name of the data provider.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getName | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/DataProvider.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/DataProvider.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Optional. Name of the data provider.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/DataProvider.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/DataProvider.php | Apache-2.0 |
public function getPrimaryContact()
{
return $this->primary_contact;
} | Optional. Email or URL of the data provider.
Max Length: 1000 bytes.
Generated from protobuf field <code>string primary_contact = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getPrimaryContact | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/DataProvider.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/DataProvider.php | Apache-2.0 |
public function setPrimaryContact($var)
{
GPBUtil::checkString($var, True);
$this->primary_contact = $var;
return $this;
} | Optional. Email or URL of the data provider.
Max Length: 1000 bytes.
Generated from protobuf field <code>string primary_contact = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setPrimaryContact | php | googleapis/google-cloud-php | BigQueryAnalyticsHub/src/V1/DataProvider.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryAnalyticsHub/src/V1/DataProvider.php | Apache-2.0 |
public function getApplication()
{
return $this->application;
} | Output only. The name of the Azure Active Directory Application.
Generated from protobuf field <code>string application = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getApplication | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setApplication($var)
{
GPBUtil::checkString($var, True);
$this->application = $var;
return $this;
} | Output only. The name of the Azure Active Directory Application.
Generated from protobuf field <code>string application = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setApplication | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getClientId()
{
return $this->client_id;
} | Output only. The client id of the Azure Active Directory Application.
Generated from protobuf field <code>string client_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getClientId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setClientId($var)
{
GPBUtil::checkString($var, True);
$this->client_id = $var;
return $this;
} | Output only. The client id of the Azure Active Directory Application.
Generated from protobuf field <code>string client_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setClientId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getObjectId()
{
return $this->object_id;
} | Output only. The object id of the Azure Active Directory Application.
Generated from protobuf field <code>string object_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getObjectId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setObjectId($var)
{
GPBUtil::checkString($var, True);
$this->object_id = $var;
return $this;
} | Output only. The object id of the Azure Active Directory Application.
Generated from protobuf field <code>string object_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setObjectId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getCustomerTenantId()
{
return $this->customer_tenant_id;
} | The id of customer's directory that host the data.
Generated from protobuf field <code>string customer_tenant_id = 4;</code>
@return string | getCustomerTenantId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setCustomerTenantId($var)
{
GPBUtil::checkString($var, True);
$this->customer_tenant_id = $var;
return $this;
} | The id of customer's directory that host the data.
Generated from protobuf field <code>string customer_tenant_id = 4;</code>
@param string $var
@return $this | setCustomerTenantId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getRedirectUri()
{
return $this->redirect_uri;
} | The URL user will be redirected to after granting consent during connection
setup.
Generated from protobuf field <code>string redirect_uri = 5;</code>
@return string | getRedirectUri | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setRedirectUri($var)
{
GPBUtil::checkString($var, True);
$this->redirect_uri = $var;
return $this;
} | The URL user will be redirected to after granting consent during connection
setup.
Generated from protobuf field <code>string redirect_uri = 5;</code>
@param string $var
@return $this | setRedirectUri | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getFederatedApplicationClientId()
{
return $this->federated_application_client_id;
} | The client ID of the user's Azure Active Directory Application used for a
federated connection.
Generated from protobuf field <code>string federated_application_client_id = 6;</code>
@return string | getFederatedApplicationClientId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setFederatedApplicationClientId($var)
{
GPBUtil::checkString($var, True);
$this->federated_application_client_id = $var;
return $this;
} | The client ID of the user's Azure Active Directory Application used for a
federated connection.
Generated from protobuf field <code>string federated_application_client_id = 6;</code>
@param string $var
@return $this | setFederatedApplicationClientId | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getIdentity()
{
return $this->identity;
} | Output only. A unique Google-owned and Google-generated identity for the
Connection. This identity will be used to access the user's Azure Active
Directory Application.
Generated from protobuf field <code>string identity = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getIdentity | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function setIdentity($var)
{
GPBUtil::checkString($var, True);
$this->identity = $var;
return $this;
} | Output only. A unique Google-owned and Google-generated identity for the
Connection. This identity will be used to access the user's Azure Active
Directory Application.
Generated from protobuf field <code>string identity = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setIdentity | php | googleapis/google-cloud-php | BigQueryConnection/src/V1/AzureProperties.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryConnection/src/V1/AzureProperties.php | Apache-2.0 |
public function getExecutionStageName()
{
return $this->execution_stage_name;
} | The name of the execution stage.
Generated from protobuf field <code>string execution_stage_name = 1;</code>
@return string | getExecutionStageName | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function setExecutionStageName($var)
{
GPBUtil::checkString($var, True);
$this->execution_stage_name = $var;
return $this;
} | The name of the execution stage.
Generated from protobuf field <code>string execution_stage_name = 1;</code>
@param string $var
@return $this | setExecutionStageName | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function getExecutionStageState()
{
return $this->execution_stage_state;
} | Executions stage states allow the same set of values as JobState.
Generated from protobuf field <code>.google.dataflow.v1beta3.JobState execution_stage_state = 2;</code>
@return int | getExecutionStageState | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function setExecutionStageState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Dataflow\V1beta3\JobState::class);
$this->execution_stage_state = $var;
return $this;
} | Executions stage states allow the same set of values as JobState.
Generated from protobuf field <code>.google.dataflow.v1beta3.JobState execution_stage_state = 2;</code>
@param int $var
@return $this | setExecutionStageState | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function getCurrentStateTime()
{
return $this->current_state_time;
} | The time at which the stage transitioned to this state.
Generated from protobuf field <code>.google.protobuf.Timestamp current_state_time = 3;</code>
@return \Google\Protobuf\Timestamp|null | getCurrentStateTime | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function setCurrentStateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->current_state_time = $var;
return $this;
} | The time at which the stage transitioned to this state.
Generated from protobuf field <code>.google.protobuf.Timestamp current_state_time = 3;</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCurrentStateTime | php | googleapis/google-cloud-php | Dataflow/src/V1beta3/ExecutionStageState.php | https://github.com/googleapis/google-cloud-php/blob/master/Dataflow/src/V1beta3/ExecutionStageState.php | Apache-2.0 |
public function getFilter()
{
return isset($this->filter) ? $this->filter : '';
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@return string | getFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setFilter($var)
{
GPBUtil::checkString($var, True);
$this->filter = $var;
return $this;
} | A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
Generated from protobuf field <code>optional string filter = 336120696;</code>
@param string $var
@return $this | setFilter | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getInstance()
{
return $this->instance;
} | Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
Generated from protobuf field <code>string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getInstance | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setInstance($var)
{
GPBUtil::checkString($var, True);
$this->instance = $var;
return $this;
} | Name of the target instance scoping this request, or '-' if the request should span over all instances in the container.
Generated from protobuf field <code>string instance = 18257045 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setInstance | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getMaxResults()
{
return isset($this->max_results) ? $this->max_results : 0;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@return int | getMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setMaxResults($var)
{
GPBUtil::checkUint32($var);
$this->max_results = $var;
return $this;
} | The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
Generated from protobuf field <code>optional uint32 max_results = 54715419;</code>
@param int $var
@return $this | setMaxResults | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getOrderBy()
{
return isset($this->order_by) ? $this->order_by : '';
} | Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Generated from protobuf field <code>optional string order_by = 160562920;</code>
@return string | getOrderBy | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setOrderBy($var)
{
GPBUtil::checkString($var, True);
$this->order_by = $var;
return $this;
} | Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.
Generated from protobuf field <code>optional string order_by = 160562920;</code>
@param string $var
@return $this | setOrderBy | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getPageToken()
{
return isset($this->page_token) ? $this->page_token : '';
} | Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Generated from protobuf field <code>optional string page_token = 19994697;</code>
@return string | getPageToken | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setPageToken($var)
{
GPBUtil::checkString($var, True);
$this->page_token = $var;
return $this;
} | Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
Generated from protobuf field <code>optional string page_token = 19994697;</code>
@param string $var
@return $this | setPageToken | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getProject()
{
return $this->project;
} | Project ID for this request.
Generated from protobuf field <code>string project = 227560217 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getProject | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setProject($var)
{
GPBUtil::checkString($var, True);
$this->project = $var;
return $this;
} | Project ID for this request.
Generated from protobuf field <code>string project = 227560217 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setProject | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getReturnPartialSuccess()
{
return isset($this->return_partial_success) ? $this->return_partial_success : false;
} | Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Generated from protobuf field <code>optional bool return_partial_success = 517198390;</code>
@return bool | getReturnPartialSuccess | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setReturnPartialSuccess($var)
{
GPBUtil::checkBool($var);
$this->return_partial_success = $var;
return $this;
} | Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
Generated from protobuf field <code>optional bool return_partial_success = 517198390;</code>
@param bool $var
@return $this | setReturnPartialSuccess | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getZone()
{
return $this->zone;
} | The name of the zone for this request.
Generated from protobuf field <code>string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getZone | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function setZone($var)
{
GPBUtil::checkString($var, True);
$this->zone = $var;
return $this;
} | The name of the zone for this request.
Generated from protobuf field <code>string zone = 3744684 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setZone | php | googleapis/google-cloud-php | Compute/src/V1/ListReferrersInstancesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/ListReferrersInstancesRequest.php | Apache-2.0 |
public function getBannedPhrases()
{
return $this->banned_phrases;
} | Banned phrases for generated text.
Generated from protobuf field <code>repeated .google.cloud.dialogflow.cx.v3.SafetySettings.Phrase banned_phrases = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getBannedPhrases | php | googleapis/google-cloud-php | DialogflowCx/src/V3/SafetySettings.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/SafetySettings.php | Apache-2.0 |
public function setBannedPhrases($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Dialogflow\Cx\V3\SafetySettings\Phrase::class);
$this->banned_phrases = $arr;
return $this;
} | Banned phrases for generated text.
Generated from protobuf field <code>repeated .google.cloud.dialogflow.cx.v3.SafetySettings.Phrase banned_phrases = 1;</code>
@param array<\Google\Cloud\Dialogflow\Cx\V3\SafetySettings\Phrase>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setBannedPhrases | php | googleapis/google-cloud-php | DialogflowCx/src/V3/SafetySettings.php | https://github.com/googleapis/google-cloud-php/blob/master/DialogflowCx/src/V3/SafetySettings.php | Apache-2.0 |
public function getKey()
{
return $this->key;
} | The value key.
Generated from protobuf field <code>string key = 1;</code>
@return string | getKey | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function setKey($var)
{
GPBUtil::checkString($var, True);
$this->key = $var;
return $this;
} | The value key.
Generated from protobuf field <code>string key = 1;</code>
@param string $var
@return $this | setKey | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function getValueType()
{
return $this->value_type;
} | The value type.
Generated from protobuf field <code>.google.api.MetricDescriptor.ValueType value_type = 2;</code>
@return int | getValueType | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function setValueType($var)
{
GPBUtil::checkEnum($var, \Google\Api\MetricDescriptor\ValueType::class);
$this->value_type = $var;
return $this;
} | The value type.
Generated from protobuf field <code>.google.api.MetricDescriptor.ValueType value_type = 2;</code>
@param int $var
@return $this | setValueType | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function getMetricKind()
{
return $this->metric_kind;
} | The value stream kind.
Generated from protobuf field <code>.google.api.MetricDescriptor.MetricKind metric_kind = 3;</code>
@return int | getMetricKind | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function setMetricKind($var)
{
GPBUtil::checkEnum($var, \Google\Api\MetricDescriptor\MetricKind::class);
$this->metric_kind = $var;
return $this;
} | The value stream kind.
Generated from protobuf field <code>.google.api.MetricDescriptor.MetricKind metric_kind = 3;</code>
@param int $var
@return $this | setMetricKind | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
public function getUnit()
{
return $this->unit;
} | The unit in which `time_series` point values are reported. `unit`
follows the UCUM format for units as seen in
https://unitsofmeasure.org/ucum.html.
`unit` is only valid if `value_type` is INTEGER, DOUBLE, DISTRIBUTION.
Generated from protobuf field <code>string unit = 4;</code>
@return string | getUnit | php | googleapis/google-cloud-php | Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/TimeSeriesDescriptor/ValueDescriptor.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.