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 setTextSegmentType($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\AutoMl\V1\Document\Layout\TextSegmentType::class);
$this->text_segment_type = $var;
return $this;
} | The type of the [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in document.
Generated from protobuf field <code>.google.cloud.automl.v1.Document.Layout.TextSegmentType text_segment_type = 4;</code>
@param int $var
@return $this | setTextSegmentType | php | googleapis/google-cloud-php | AutoMl/src/V1/Document/Layout.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/Document/Layout.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Required. The name of the QaScorecard to get.
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 | ContactCenterInsights/src/V1/GetQaScorecardRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/GetQaScorecardRequest.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Required. The name of the QaScorecard to get.
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 | ContactCenterInsights/src/V1/GetQaScorecardRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/ContactCenterInsights/src/V1/GetQaScorecardRequest.php | Apache-2.0 |
public function getTitle()
{
return $this->title;
} | Title of the document.
Generated from protobuf field <code>string title = 1;</code>
@return string | getTitle | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function setTitle($var)
{
GPBUtil::checkString($var, True);
$this->title = $var;
return $this;
} | Title of the document.
Generated from protobuf field <code>string title = 1;</code>
@param string $var
@return $this | setTitle | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function getDocument()
{
return $this->document;
} | Required.
[Document.name][google.cloud.discoveryengine.v1.Document.name] of the
document. Full resource name of the referenced document, in the format
`projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
Generated from protobuf field <code>string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@return string | getDocument | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function setDocument($var)
{
GPBUtil::checkString($var, True);
$this->document = $var;
return $this;
} | Required.
[Document.name][google.cloud.discoveryengine.v1.Document.name] of the
document. Full resource name of the referenced document, in the format
`projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
Generated from protobuf field <code>string document = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {</code>
@param string $var
@return $this | setDocument | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function getUri()
{
return $this->uri;
} | Cloud Storage or HTTP uri for the document.
Generated from protobuf field <code>string uri = 3;</code>
@return string | getUri | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function setUri($var)
{
GPBUtil::checkString($var, True);
$this->uri = $var;
return $this;
} | Cloud Storage or HTTP uri for the document.
Generated from protobuf field <code>string uri = 3;</code>
@param string $var
@return $this | setUri | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function getChunkContents()
{
return $this->chunk_contents;
} | List of cited chunk contents derived from document content.
Generated from protobuf field <code>repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;</code>
@return \Google\Protobuf\Internal\RepeatedField | getChunkContents | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | Apache-2.0 |
public function setChunkContents($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\Reference\ChunkContent::class);
$this->chunk_contents = $arr;
return $this;
} | List of cited chunk contents derived from document content.
Generated from protobuf field <code>repeated .google.cloud.discoveryengine.v1.SearchResponse.Summary.Reference.ChunkContent chunk_contents = 4;</code>
@param array<\Google\Cloud\DiscoveryEngine\V1\SearchResponse\Summary\Reference\ChunkContent>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setChunkContents | php | googleapis/google-cloud-php | DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.php | https://github.com/googleapis/google-cloud-php/blob/master/DiscoveryEngine/src/V1/SearchResponse/Summary/Reference.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, (.google.cloud.operation_request_field) = "project"];</code>
@return string | getProject | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.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, (.google.cloud.operation_request_field) = "project"];</code>
@param string $var
@return $this | setProject | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.php | Apache-2.0 |
public function getRequestId()
{
return isset($this->request_id) ? $this->request_id : '';
} | An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>optional string request_id = 37109963;</code>
@return string | getRequestId | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
Generated from protobuf field <code>optional string request_id = 37109963;</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.php | Apache-2.0 |
public function getTargetSslProxyResource()
{
return $this->target_ssl_proxy_resource;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.TargetSslProxy target_ssl_proxy_resource = 142016192 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Compute\V1\TargetSslProxy|null | getTargetSslProxyResource | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.php | Apache-2.0 |
public function setTargetSslProxyResource($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\TargetSslProxy::class);
$this->target_ssl_proxy_resource = $var;
return $this;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.TargetSslProxy target_ssl_proxy_resource = 142016192 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Compute\V1\TargetSslProxy $var
@return $this | setTargetSslProxyResource | php | googleapis/google-cloud-php | Compute/src/V1/InsertTargetSslProxyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/InsertTargetSslProxyRequest.php | Apache-2.0 |
public function getOrgPolicyResults()
{
return $this->org_policy_results;
} | The organization policies under the
[AnalyzeOrgPoliciesRequest.scope][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.scope]
with the
[AnalyzeOrgPoliciesRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.constraint].
Generated from protobuf field <code>repeated .google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult org_policy_results = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getOrgPolicyResults | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function setOrgPolicyResults($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Asset\V1\AnalyzeOrgPoliciesResponse\OrgPolicyResult::class);
$this->org_policy_results = $arr;
return $this;
} | The organization policies under the
[AnalyzeOrgPoliciesRequest.scope][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.scope]
with the
[AnalyzeOrgPoliciesRequest.constraint][google.cloud.asset.v1.AnalyzeOrgPoliciesRequest.constraint].
Generated from protobuf field <code>repeated .google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.OrgPolicyResult org_policy_results = 1;</code>
@param array<\Google\Cloud\Asset\V1\AnalyzeOrgPoliciesResponse\OrgPolicyResult>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setOrgPolicyResults | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function getConstraint()
{
return $this->constraint;
} | The definition of the constraint in the request.
Generated from protobuf field <code>.google.cloud.asset.v1.AnalyzerOrgPolicyConstraint constraint = 2;</code>
@return \Google\Cloud\Asset\V1\AnalyzerOrgPolicyConstraint|null | getConstraint | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function setConstraint($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Asset\V1\AnalyzerOrgPolicyConstraint::class);
$this->constraint = $var;
return $this;
} | The definition of the constraint in the request.
Generated from protobuf field <code>.google.cloud.asset.v1.AnalyzerOrgPolicyConstraint constraint = 2;</code>
@param \Google\Cloud\Asset\V1\AnalyzerOrgPolicyConstraint $var
@return $this | setConstraint | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | The page token to fetch the next page for
[AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
Generated from protobuf field <code>string next_page_token = 3;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | The page token to fetch the next page for
[AnalyzeOrgPoliciesResponse.org_policy_results][google.cloud.asset.v1.AnalyzeOrgPoliciesResponse.org_policy_results].
Generated from protobuf field <code>string next_page_token = 3;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | Asset/src/V1/AnalyzeOrgPoliciesResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Asset/src/V1/AnalyzeOrgPoliciesResponse.php | Apache-2.0 |
public function getCommitTimestamp()
{
return $this->commit_timestamp;
} | The Cloud Spanner timestamp at which the transaction committed.
Generated from protobuf field <code>.google.protobuf.Timestamp commit_timestamp = 1;</code>
@return \Google\Protobuf\Timestamp|null | getCommitTimestamp | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function setCommitTimestamp($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->commit_timestamp = $var;
return $this;
} | The Cloud Spanner timestamp at which the transaction committed.
Generated from protobuf field <code>.google.protobuf.Timestamp commit_timestamp = 1;</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCommitTimestamp | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function getCommitStats()
{
return $this->commit_stats;
} | The statistics about this Commit. Not returned by default.
For more information, see
[CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
Generated from protobuf field <code>.google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;</code>
@return \Google\Cloud\Spanner\V1\CommitResponse\CommitStats|null | getCommitStats | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function setCommitStats($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\CommitResponse\CommitStats::class);
$this->commit_stats = $var;
return $this;
} | The statistics about this Commit. Not returned by default.
For more information, see
[CommitRequest.return_commit_stats][google.spanner.v1.CommitRequest.return_commit_stats].
Generated from protobuf field <code>.google.spanner.v1.CommitResponse.CommitStats commit_stats = 2;</code>
@param \Google\Cloud\Spanner\V1\CommitResponse\CommitStats $var
@return $this | setCommitStats | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function getPrecommitToken()
{
return $this->readOneof(4);
} | If specified, transaction has not committed yet.
Clients must retry the commit with the new precommit token.
Generated from protobuf field <code>.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4;</code>
@return \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken|null | getPrecommitToken | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function setPrecommitToken($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken::class);
$this->writeOneof(4, $var);
return $this;
} | If specified, transaction has not committed yet.
Clients must retry the commit with the new precommit token.
Generated from protobuf field <code>.google.spanner.v1.MultiplexedSessionPrecommitToken precommit_token = 4;</code>
@param \Google\Cloud\Spanner\V1\MultiplexedSessionPrecommitToken $var
@return $this | setPrecommitToken | php | googleapis/google-cloud-php | Spanner/src/V1/CommitResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Spanner/src/V1/CommitResponse.php | Apache-2.0 |
public function getExecutionId()
{
return $this->execution_id;
} | The unique ID of the command execution for polling.
Generated from protobuf field <code>string execution_id = 1;</code>
@return string | getExecutionId | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function setExecutionId($var)
{
GPBUtil::checkString($var, True);
$this->execution_id = $var;
return $this;
} | The unique ID of the command execution for polling.
Generated from protobuf field <code>string execution_id = 1;</code>
@param string $var
@return $this | setExecutionId | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function getPod()
{
return $this->pod;
} | The name of the pod where the command is executed.
Generated from protobuf field <code>string pod = 2;</code>
@return string | getPod | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function setPod($var)
{
GPBUtil::checkString($var, True);
$this->pod = $var;
return $this;
} | The name of the pod where the command is executed.
Generated from protobuf field <code>string pod = 2;</code>
@param string $var
@return $this | setPod | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function getPodNamespace()
{
return $this->pod_namespace;
} | The namespace of the pod where the command is executed.
Generated from protobuf field <code>string pod_namespace = 3;</code>
@return string | getPodNamespace | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function setPodNamespace($var)
{
GPBUtil::checkString($var, True);
$this->pod_namespace = $var;
return $this;
} | The namespace of the pod where the command is executed.
Generated from protobuf field <code>string pod_namespace = 3;</code>
@param string $var
@return $this | setPodNamespace | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function getError()
{
return $this->error;
} | Error message. Empty if there was no error.
Generated from protobuf field <code>string error = 4;</code>
@return string | getError | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function setError($var)
{
GPBUtil::checkString($var, True);
$this->error = $var;
return $this;
} | Error message. Empty if there was no error.
Generated from protobuf field <code>string error = 4;</code>
@param string $var
@return $this | setError | php | googleapis/google-cloud-php | OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/OrchestrationAirflow/src/V1/ExecuteAirflowCommandResponse.php | Apache-2.0 |
public function getCustomer()
{
return $this->customer;
} | Required. The customer to create.
Generated from protobuf field <code>.google.cloud.channel.v1.Customer customer = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Channel\V1\Customer|null | getCustomer | php | googleapis/google-cloud-php | Channel/src/V1/CreateCustomerRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Channel/src/V1/CreateCustomerRequest.php | Apache-2.0 |
public function setCustomer($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Channel\V1\Customer::class);
$this->customer = $var;
return $this;
} | Required. The customer to create.
Generated from protobuf field <code>.google.cloud.channel.v1.Customer customer = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Channel\V1\Customer $var
@return $this | setCustomer | php | googleapis/google-cloud-php | Channel/src/V1/CreateCustomerRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Channel/src/V1/CreateCustomerRequest.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Output only. The resource name of the PublisherModel.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getName | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Output only. The resource name of the PublisherModel.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getVersionId()
{
return $this->version_id;
} | Output only. Immutable. The version ID of the PublisherModel.
A new version is committed when a new model version is uploaded under an
existing model id. It is an auto-incrementing decimal number in string
representation.
Generated from protobuf field <code>string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getVersionId | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setVersionId($var)
{
GPBUtil::checkString($var, True);
$this->version_id = $var;
return $this;
} | Output only. Immutable. The version ID of the PublisherModel.
A new version is committed when a new model version is uploaded under an
existing model id. It is an auto-incrementing decimal number in string
representation.
Generated from protobuf field <code>string version_id = 2 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setVersionId | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getOpenSourceCategory()
{
return $this->open_source_category;
} | Required. Indicates the open source category of the publisher model.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];</code>
@return int | getOpenSourceCategory | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setOpenSourceCategory($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\PublisherModel\OpenSourceCategory::class);
$this->open_source_category = $var;
return $this;
} | Required. Indicates the open source category of the publisher model.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.OpenSourceCategory open_source_category = 7 [(.google.api.field_behavior) = REQUIRED];</code>
@param int $var
@return $this | setOpenSourceCategory | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getSupportedActions()
{
return $this->supported_actions;
} | Optional. Supported call-to-action options.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\AIPlatform\V1\PublisherModel\CallToAction|null | getSupportedActions | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setSupportedActions($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\PublisherModel\CallToAction::class);
$this->supported_actions = $var;
return $this;
} | Optional. Supported call-to-action options.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.CallToAction supported_actions = 19 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\AIPlatform\V1\PublisherModel\CallToAction $var
@return $this | setSupportedActions | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getFrameworks()
{
return $this->frameworks;
} | Optional. Additional information about the model's Frameworks.
Generated from protobuf field <code>repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Protobuf\Internal\RepeatedField | getFrameworks | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setFrameworks($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->frameworks = $arr;
return $this;
} | Optional. Additional information about the model's Frameworks.
Generated from protobuf field <code>repeated string frameworks = 23 [(.google.api.field_behavior) = OPTIONAL];</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setFrameworks | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getLaunchStage()
{
return $this->launch_stage;
} | Optional. Indicates the launch stage of the model.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getLaunchStage | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setLaunchStage($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\PublisherModel\LaunchStage::class);
$this->launch_stage = $var;
return $this;
} | Optional. Indicates the launch stage of the model.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.LaunchStage launch_stage = 29 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setLaunchStage | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getVersionState()
{
return $this->version_state;
} | Optional. Indicates the state of the model version.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.VersionState version_state = 37 [(.google.api.field_behavior) = OPTIONAL];</code>
@return int | getVersionState | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setVersionState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\AIPlatform\V1\PublisherModel\VersionState::class);
$this->version_state = $var;
return $this;
} | Optional. Indicates the state of the model version.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PublisherModel.VersionState version_state = 37 [(.google.api.field_behavior) = OPTIONAL];</code>
@param int $var
@return $this | setVersionState | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getPublisherModelTemplate()
{
return $this->publisher_model_template;
} | Optional. Output only. Immutable. Used to indicate this model has a
publisher model and provide the template of the publisher model resource
name.
Generated from protobuf field <code>string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return string | getPublisherModelTemplate | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setPublisherModelTemplate($var)
{
GPBUtil::checkString($var, True);
$this->publisher_model_template = $var;
return $this;
} | Optional. Output only. Immutable. Used to indicate this model has a
publisher model and provide the template of the publisher model resource
name.
Generated from protobuf field <code>string publisher_model_template = 30 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param string $var
@return $this | setPublisherModelTemplate | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getPredictSchemata()
{
return $this->predict_schemata;
} | Optional. The schemata that describes formats of the PublisherModel's
predictions and explanations as given and returned via
[PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];</code>
@return \Google\Cloud\AIPlatform\V1\PredictSchemata|null | getPredictSchemata | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function setPredictSchemata($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\PredictSchemata::class);
$this->predict_schemata = $var;
return $this;
} | Optional. The schemata that describes formats of the PublisherModel's
predictions and explanations as given and returned via
[PredictionService.Predict][google.cloud.aiplatform.v1.PredictionService.Predict].
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PredictSchemata predict_schemata = 31 [(.google.api.field_behavior) = OPTIONAL];</code>
@param \Google\Cloud\AIPlatform\V1\PredictSchemata $var
@return $this | setPredictSchemata | php | googleapis/google-cloud-php | AiPlatform/src/V1/PublisherModel.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PublisherModel.php | Apache-2.0 |
public function getParameter()
{
return $this->parameter;
} | Required. The name of the parameter to mutate.
This value must:
* be less than 40 characters.
* be unique across across all mutations within the rule
* consist only of letters, digits or _ (underscores)
For event edit rules, the name may also be set to 'event_name' to modify
the event_name in place.
Generated from protobuf field <code>string parameter = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getParameter | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ParameterMutation.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ParameterMutation.php | Apache-2.0 |
public function setParameter($var)
{
GPBUtil::checkString($var, True);
$this->parameter = $var;
return $this;
} | Required. The name of the parameter to mutate.
This value must:
* be less than 40 characters.
* be unique across across all mutations within the rule
* consist only of letters, digits or _ (underscores)
For event edit rules, the name may also be set to 'event_name' to modify
the event_name in place.
Generated from protobuf field <code>string parameter = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setParameter | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ParameterMutation.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ParameterMutation.php | Apache-2.0 |
public function getParameterValue()
{
return $this->parameter_value;
} | Required. The value mutation to perform.
* Must be less than 100 characters.
* To specify a constant value for the param, use the value's string.
* To copy value from another parameter, use syntax like
"[[other_parameter]]" For more details, see this [help center
article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
Generated from protobuf field <code>string parameter_value = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getParameterValue | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ParameterMutation.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ParameterMutation.php | Apache-2.0 |
public function setParameterValue($var)
{
GPBUtil::checkString($var, True);
$this->parameter_value = $var;
return $this;
} | Required. The value mutation to perform.
* Must be less than 100 characters.
* To specify a constant value for the param, use the value's string.
* To copy value from another parameter, use syntax like
"[[other_parameter]]" For more details, see this [help center
article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters).
Generated from protobuf field <code>string parameter_value = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setParameterValue | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ParameterMutation.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ParameterMutation.php | Apache-2.0 |
public function getGcsSource()
{
return $this->readOneof(1);
} | Required. The Google Cloud Storage location for the input content.
Generated from protobuf field <code>.google.cloud.automl.v1.GcsSource gcs_source = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\AutoMl\V1\GcsSource|null | getGcsSource | php | googleapis/google-cloud-php | AutoMl/src/V1/BatchPredictInputConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/BatchPredictInputConfig.php | Apache-2.0 |
public function setGcsSource($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AutoMl\V1\GcsSource::class);
$this->writeOneof(1, $var);
return $this;
} | Required. The Google Cloud Storage location for the input content.
Generated from protobuf field <code>.google.cloud.automl.v1.GcsSource gcs_source = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\AutoMl\V1\GcsSource $var
@return $this | setGcsSource | php | googleapis/google-cloud-php | AutoMl/src/V1/BatchPredictInputConfig.php | https://github.com/googleapis/google-cloud-php/blob/master/AutoMl/src/V1/BatchPredictInputConfig.php | Apache-2.0 |
public function getConfig()
{
return $this->config;
} | The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
Generated from protobuf field <code>optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherConfig config = 255820610;</code>
@return \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherConfig|null | getConfig | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function setConfig($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherConfig::class);
$this->config = $var;
return $this;
} | The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified.
Generated from protobuf field <code>optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherConfig config = 255820610;</code>
@param \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherConfig $var
@return $this | setConfig | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function getExpr()
{
return $this->expr;
} | User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Expr expr = 3127797;</code>
@return \Google\Cloud\Compute\V1\Expr|null | getExpr | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function setExpr($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\Expr::class);
$this->expr = $var;
return $this;
} | User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. Expressions containing `evaluateThreatIntelligence` require Cloud Armor Managed Protection Plus tier and are not supported in Edge Policies nor in Regional Policies. Expressions containing `evaluatePreconfiguredExpr('sourceiplist-*')` require Cloud Armor Managed Protection Plus tier and are only supported in Global Security Policies.
Generated from protobuf field <code>optional .google.cloud.compute.v1.Expr expr = 3127797;</code>
@param \Google\Cloud\Compute\V1\Expr $var
@return $this | setExpr | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function getExprOptions()
{
return $this->expr_options;
} | The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
Generated from protobuf field <code>optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherExprOptions expr_options = 486220372;</code>
@return \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherExprOptions|null | getExprOptions | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function setExprOptions($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherExprOptions::class);
$this->expr_options = $var;
return $this;
} | The configuration options available when specifying a user defined CEVAL expression (i.e., 'expr').
Generated from protobuf field <code>optional .google.cloud.compute.v1.SecurityPolicyRuleMatcherExprOptions expr_options = 486220372;</code>
@param \Google\Cloud\Compute\V1\SecurityPolicyRuleMatcherExprOptions $var
@return $this | setExprOptions | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function getVersionedExpr()
{
return isset($this->versioned_expr) ? $this->versioned_expr : '';
} | Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
Check the VersionedExpr enum for the list of possible values.
Generated from protobuf field <code>optional string versioned_expr = 322286013;</code>
@return string | getVersionedExpr | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.php | Apache-2.0 |
public function setVersionedExpr($var)
{
GPBUtil::checkString($var, True);
$this->versioned_expr = $var;
return $this;
} | Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config.
Check the VersionedExpr enum for the list of possible values.
Generated from protobuf field <code>optional string versioned_expr = 322286013;</code>
@param string $var
@return $this | setVersionedExpr | php | googleapis/google-cloud-php | Compute/src/V1/SecurityPolicyRuleMatcher.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SecurityPolicyRuleMatcher.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | Apache-2.0 |
public function getIncludeAllScopes()
{
return isset($this->include_all_scopes) ? $this->include_all_scopes : false;
} | Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Generated from protobuf field <code>optional bool include_all_scopes = 391327988;</code>
@return bool | getIncludeAllScopes | php | googleapis/google-cloud-php | Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | Apache-2.0 |
public function setIncludeAllScopes($var)
{
GPBUtil::checkBool($var);
$this->include_all_scopes = $var;
return $this;
} | Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Generated from protobuf field <code>optional bool include_all_scopes = 391327988;</code>
@param bool $var
@return $this | setIncludeAllScopes | php | googleapis/google-cloud-php | Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.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/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | Apache-2.0 |
public function getServiceProjectNumber()
{
return isset($this->service_project_number) ? $this->service_project_number : 0;
} | The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Generated from protobuf field <code>optional int64 service_project_number = 316757497;</code>
@return int|string | getServiceProjectNumber | php | googleapis/google-cloud-php | Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | Apache-2.0 |
public function setServiceProjectNumber($var)
{
GPBUtil::checkInt64($var);
$this->service_project_number = $var;
return $this;
} | The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
Generated from protobuf field <code>optional int64 service_project_number = 316757497;</code>
@param int|string $var
@return $this | setServiceProjectNumber | php | googleapis/google-cloud-php | Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AggregatedListInstanceGroupManagersRequest.php | Apache-2.0 |
public function getUpdateMask()
{
return $this->update_mask;
} | The list of fields to update.
The currently supported fields are:
`labels`
`hyperthreading_enabled`
`os_image`
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code>
@return \Google\Protobuf\FieldMask|null | getUpdateMask | php | googleapis/google-cloud-php | BareMetalSolution/src/V2/UpdateInstanceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/BareMetalSolution/src/V2/UpdateInstanceRequest.php | Apache-2.0 |
public function setUpdateMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->update_mask = $var;
return $this;
} | The list of fields to update.
The currently supported fields are:
`labels`
`hyperthreading_enabled`
`os_image`
Generated from protobuf field <code>.google.protobuf.FieldMask update_mask = 2;</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setUpdateMask | php | googleapis/google-cloud-php | BareMetalSolution/src/V2/UpdateInstanceRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/BareMetalSolution/src/V2/UpdateInstanceRequest.php | Apache-2.0 |
public function getCustomerManagedEncryption()
{
return $this->customer_managed_encryption;
} | Output only. The customer-managed encryption status of the
[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. Only
populated if customer-managed encryption is used.
Generated from protobuf field <code>.google.cloud.secretmanager.v1beta2.CustomerManagedEncryptionStatus customer_managed_encryption = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Cloud\SecretManager\V1beta2\CustomerManagedEncryptionStatus|null | getCustomerManagedEncryption | php | googleapis/google-cloud-php | SecretManager/src/V1beta2/ReplicationStatus/AutomaticStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/SecretManager/src/V1beta2/ReplicationStatus/AutomaticStatus.php | Apache-2.0 |
public function setCustomerManagedEncryption($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\SecretManager\V1beta2\CustomerManagedEncryptionStatus::class);
$this->customer_managed_encryption = $var;
return $this;
} | Output only. The customer-managed encryption status of the
[SecretVersion][google.cloud.secretmanager.v1beta2.SecretVersion]. Only
populated if customer-managed encryption is used.
Generated from protobuf field <code>.google.cloud.secretmanager.v1beta2.CustomerManagedEncryptionStatus customer_managed_encryption = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Cloud\SecretManager\V1beta2\CustomerManagedEncryptionStatus $var
@return $this | setCustomerManagedEncryption | php | googleapis/google-cloud-php | SecretManager/src/V1beta2/ReplicationStatus/AutomaticStatus.php | https://github.com/googleapis/google-cloud-php/blob/master/SecretManager/src/V1beta2/ReplicationStatus/AutomaticStatus.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Identifier. The resource name of the `Role`.
Format: `networks/{network_code}/roles/{role_id}`
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER];</code>
@return string | getName | 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 setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Identifier. The resource name of the `Role`.
Format: `networks/{network_code}/roles/{role_id}`
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER];</code>
@param string $var
@return $this | setName | 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 getRoleId()
{
return $this->role_id;
} | Output only. `Role` ID.
Generated from protobuf field <code>int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int|string | getRoleId | 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 setRoleId($var)
{
GPBUtil::checkInt64($var);
$this->role_id = $var;
return $this;
} | Output only. `Role` ID.
Generated from protobuf field <code>int64 role_id = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int|string $var
@return $this | setRoleId | 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 getDisplayName()
{
return $this->display_name;
} | Required. The display name of the `Role`.
Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getDisplayName | 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 setDisplayName($var)
{
GPBUtil::checkString($var, True);
$this->display_name = $var;
return $this;
} | Required. The display name of the `Role`.
Generated from protobuf field <code>string display_name = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setDisplayName | 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 getDescription()
{
return $this->description;
} | Optional. The description of the `Role`.
Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getDescription | 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 setDescription($var)
{
GPBUtil::checkString($var, True);
$this->description = $var;
return $this;
} | Optional. The description of the `Role`.
Generated from protobuf field <code>string description = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setDescription | 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 getBuiltIn()
{
return $this->built_in;
} | 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>
@return bool | getBuiltIn | 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 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.