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 setMetricSpec($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualitySpec::class);
$this->metric_spec = $var;
return $this;
} | Required. Spec for pairwise summarization quality score metric.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PairwiseSummarizationQualitySpec metric_spec = 1 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualitySpec $var
@return $this | setMetricSpec | php | googleapis/google-cloud-php | AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | Apache-2.0 |
public function getInstance()
{
return $this->instance;
} | Required. Pairwise summarization quality instance.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PairwiseSummarizationQualityInstance instance = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInstance|null | getInstance | php | googleapis/google-cloud-php | AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | Apache-2.0 |
public function setInstance($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInstance::class);
$this->instance = $var;
return $this;
} | Required. Pairwise summarization quality instance.
Generated from protobuf field <code>.google.cloud.aiplatform.v1.PairwiseSummarizationQualityInstance instance = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\AIPlatform\V1\PairwiseSummarizationQualityInstance $var
@return $this | setInstance | php | googleapis/google-cloud-php | AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | https://github.com/googleapis/google-cloud-php/blob/master/AiPlatform/src/V1/PairwiseSummarizationQualityInput.php | Apache-2.0 |
public function getConversationDataset()
{
return $this->conversation_dataset;
} | The resource name of the conversation dataset that will be created. Format:
`projects/<Project ID>/locations/<Location
ID>/conversationDatasets/<Conversation Dataset Id>`
Generated from protobuf field <code>string conversation_dataset = 1 [(.google.api.resource_reference) = {</code>
@return string | getConversationDataset | php | googleapis/google-cloud-php | Dialogflow/src/V2/CreateConversationDatasetOperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/CreateConversationDatasetOperationMetadata.php | Apache-2.0 |
public function setConversationDataset($var)
{
GPBUtil::checkString($var, True);
$this->conversation_dataset = $var;
return $this;
} | The resource name of the conversation dataset that will be created. Format:
`projects/<Project ID>/locations/<Location
ID>/conversationDatasets/<Conversation Dataset Id>`
Generated from protobuf field <code>string conversation_dataset = 1 [(.google.api.resource_reference) = {</code>
@param string $var
@return $this | setConversationDataset | php | googleapis/google-cloud-php | Dialogflow/src/V2/CreateConversationDatasetOperationMetadata.php | https://github.com/googleapis/google-cloud-php/blob/master/Dialogflow/src/V2/CreateConversationDatasetOperationMetadata.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. Name of the parent resource for the entitlement.
Possible formats:
* `organizations/{organization-number}/locations/{region}`
* `folders/{folder-number}/locations/{region}`
* `projects/{project-id|project-number}/locations/{region}`
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 | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. Name of the parent resource for the entitlement.
Possible formats:
* `organizations/{organization-number}/locations/{region}`
* `folders/{folder-number}/locations/{region}`
* `projects/{project-id|project-number}/locations/{region}`
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 | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function getEntitlementId()
{
return $this->entitlement_id;
} | Required. The ID to use for this entitlement. This becomes the last part of
the resource name.
This value should be 4-63 characters in length, and valid characters are
"[a-z]", "[0-9]", and "-". The first character should be from [a-z].
This value should be unique among all other entitlements under the
specified `parent`.
Generated from protobuf field <code>string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getEntitlementId | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function setEntitlementId($var)
{
GPBUtil::checkString($var, True);
$this->entitlement_id = $var;
return $this;
} | Required. The ID to use for this entitlement. This becomes the last part of
the resource name.
This value should be 4-63 characters in length, and valid characters are
"[a-z]", "[0-9]", and "-". The first character should be from [a-z].
This value should be unique among all other entitlements under the
specified `parent`.
Generated from protobuf field <code>string entitlement_id = 2 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setEntitlementId | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function getEntitlement()
{
return $this->entitlement;
} | Required. The resource being created
Generated from protobuf field <code>.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\PrivilegedAccessManager\V1\Entitlement|null | getEntitlement | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function setEntitlement($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\PrivilegedAccessManager\V1\Entitlement::class);
$this->entitlement = $var;
return $this;
} | Required. The resource being created
Generated from protobuf field <code>.google.cloud.privilegedaccessmanager.v1.Entitlement entitlement = 3 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\PrivilegedAccessManager\V1\Entitlement $var
@return $this | setEntitlement | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function getRequestId()
{
return $this->request_id;
} | Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server guarantees
this for at least 60 minutes after the first request.
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, ignores the second request and returns the
previous operation's response. This prevents clients from accidentally
creating duplicate entitlements.
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>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@return string | getRequestId | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function setRequestId($var)
{
GPBUtil::checkString($var, True);
$this->request_id = $var;
return $this;
} | Optional. An optional request ID to identify requests. Specify a unique
request ID so that if you must retry your request, the server knows to
ignore the request if it has already been completed. The server guarantees
this for at least 60 minutes after the first request.
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, ignores the second request and returns the
previous operation's response. This prevents clients from accidentally
creating duplicate entitlements.
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>string request_id = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
@param string $var
@return $this | setRequestId | php | googleapis/google-cloud-php | PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/PrivilegedAccessManager/src/V1/CreateEntitlementRequest.php | Apache-2.0 |
public function getFirewallPolicy()
{
return $this->firewall_policy;
} | Name of the firewall policy to update.
Generated from protobuf field <code>string firewall_policy = 498173265 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getFirewallPolicy | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function setFirewallPolicy($var)
{
GPBUtil::checkString($var, True);
$this->firewall_policy = $var;
return $this;
} | Name of the firewall policy to update.
Generated from protobuf field <code>string firewall_policy = 498173265 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setFirewallPolicy | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function getFirewallPolicyAssociationResource()
{
return $this->firewall_policy_association_resource;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.FirewallPolicyAssociation firewall_policy_association_resource = 259546170 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Compute\V1\FirewallPolicyAssociation|null | getFirewallPolicyAssociationResource | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function setFirewallPolicyAssociationResource($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\FirewallPolicyAssociation::class);
$this->firewall_policy_association_resource = $var;
return $this;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.FirewallPolicyAssociation firewall_policy_association_resource = 259546170 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Compute\V1\FirewallPolicyAssociation $var
@return $this | setFirewallPolicyAssociationResource | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function getReplaceExistingAssociation()
{
return isset($this->replace_existing_association) ? $this->replace_existing_association : false;
} | Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Generated from protobuf field <code>optional bool replace_existing_association = 209541240;</code>
@return bool | getReplaceExistingAssociation | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function setReplaceExistingAssociation($var)
{
GPBUtil::checkBool($var);
$this->replace_existing_association = $var;
return $this;
} | Indicates whether or not to replace it if an association of the attachment already exists. This is false by default, in which case an error will be returned if an association already exists.
Generated from protobuf field <code>optional bool replace_existing_association = 209541240;</code>
@param bool $var
@return $this | setReplaceExistingAssociation | php | googleapis/google-cloud-php | Compute/src/V1/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.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/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.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/AddAssociationFirewallPolicyRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/AddAssociationFirewallPolicyRequest.php | Apache-2.0 |
public function getExpandedDataSets()
{
return $this->expanded_data_sets;
} | List of ExpandedDataSet. These will be ordered stably, but in an arbitrary
order.
Generated from protobuf field <code>repeated .google.analytics.admin.v1alpha.ExpandedDataSet expanded_data_sets = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getExpandedDataSets | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | Apache-2.0 |
public function setExpandedDataSets($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Analytics\Admin\V1alpha\ExpandedDataSet::class);
$this->expanded_data_sets = $arr;
return $this;
} | List of ExpandedDataSet. These will be ordered stably, but in an arbitrary
order.
Generated from protobuf field <code>repeated .google.analytics.admin.v1alpha.ExpandedDataSet expanded_data_sets = 1;</code>
@param array<\Google\Analytics\Admin\V1alpha\ExpandedDataSet>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setExpandedDataSets | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | A token, which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/AnalyticsAdmin/src/V1alpha/ListExpandedDataSetsResponse.php | Apache-2.0 |
public function getSchema()
{
return $this->schema;
} | Json serialized schema, as described at
https://avro.apache.org/docs/1.8.1/spec.html.
Generated from protobuf field <code>string schema = 1;</code>
@return string | getSchema | php | googleapis/google-cloud-php | BigQueryStorage/src/V1/AvroSchema.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryStorage/src/V1/AvroSchema.php | Apache-2.0 |
public function setSchema($var)
{
GPBUtil::checkString($var, True);
$this->schema = $var;
return $this;
} | Json serialized schema, as described at
https://avro.apache.org/docs/1.8.1/spec.html.
Generated from protobuf field <code>string schema = 1;</code>
@param string $var
@return $this | setSchema | php | googleapis/google-cloud-php | BigQueryStorage/src/V1/AvroSchema.php | https://github.com/googleapis/google-cloud-php/blob/master/BigQueryStorage/src/V1/AvroSchema.php | Apache-2.0 |
public function getCiphertext()
{
return $this->ciphertext;
} | The encrypted data. In the case of AES-GCM, the authentication tag
is the [tag_length][google.cloud.kms.v1.RawEncryptResponse.tag_length]
bytes at the end of this field.
Generated from protobuf field <code>bytes ciphertext = 1;</code>
@return string | getCiphertext | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setCiphertext($var)
{
GPBUtil::checkString($var, False);
$this->ciphertext = $var;
return $this;
} | The encrypted data. In the case of AES-GCM, the authentication tag
is the [tag_length][google.cloud.kms.v1.RawEncryptResponse.tag_length]
bytes at the end of this field.
Generated from protobuf field <code>bytes ciphertext = 1;</code>
@param string $var
@return $this | setCiphertext | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getInitializationVector()
{
return $this->initialization_vector;
} | The initialization vector (IV) generated by the service during
encryption. This value must be stored and provided in
[RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]
at decryption time.
Generated from protobuf field <code>bytes initialization_vector = 2;</code>
@return string | getInitializationVector | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setInitializationVector($var)
{
GPBUtil::checkString($var, False);
$this->initialization_vector = $var;
return $this;
} | The initialization vector (IV) generated by the service during
encryption. This value must be stored and provided in
[RawDecryptRequest.initialization_vector][google.cloud.kms.v1.RawDecryptRequest.initialization_vector]
at decryption time.
Generated from protobuf field <code>bytes initialization_vector = 2;</code>
@param string $var
@return $this | setInitializationVector | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getTagLength()
{
return $this->tag_length;
} | The length of the authentication tag that is appended to
the end of the ciphertext.
Generated from protobuf field <code>int32 tag_length = 3;</code>
@return int | getTagLength | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setTagLength($var)
{
GPBUtil::checkInt32($var);
$this->tag_length = $var;
return $this;
} | The length of the authentication tag that is appended to
the end of the ciphertext.
Generated from protobuf field <code>int32 tag_length = 3;</code>
@param int $var
@return $this | setTagLength | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getCiphertextCrc32C()
{
return $this->ciphertext_crc32c;
} | Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext and comparing your results to this field. Discard
the response in case of non-matching checksum values, and perform a limited
number of retries. A persistent mismatch may indicate an issue in your
computation of the CRC32C checksum. Note: This field is defined as int64
for reasons of compatibility across different languages. However, it is a
non-negative integer, which will never exceed 2^32-1, and can be safely
downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code>
@return \Google\Protobuf\Int64Value|null | getCiphertextCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getCiphertextCrc32CUnwrapped()
{
return $this->readWrapperValue("ciphertext_crc32c");
} | Returns the unboxed value from <code>getCiphertextCrc32C()</code>
Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext and comparing your results to this field. Discard
the response in case of non-matching checksum values, and perform a limited
number of retries. A persistent mismatch may indicate an issue in your
computation of the CRC32C checksum. Note: This field is defined as int64
for reasons of compatibility across different languages. However, it is a
non-negative integer, which will never exceed 2^32-1, and can be safely
downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code>
@return int|string|null | getCiphertextCrc32CUnwrapped | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setCiphertextCrc32C($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Int64Value::class);
$this->ciphertext_crc32c = $var;
return $this;
} | Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext and comparing your results to this field. Discard
the response in case of non-matching checksum values, and perform a limited
number of retries. A persistent mismatch may indicate an issue in your
computation of the CRC32C checksum. Note: This field is defined as int64
for reasons of compatibility across different languages. However, it is a
non-negative integer, which will never exceed 2^32-1, and can be safely
downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code>
@param \Google\Protobuf\Int64Value $var
@return $this | setCiphertextCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setCiphertextCrc32CUnwrapped($var)
{
$this->writeWrapperValue("ciphertext_crc32c", $var);
return $this;} | Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.ciphertext][google.cloud.kms.v1.RawEncryptResponse.ciphertext].
An integrity check of ciphertext can be performed by computing the CRC32C
checksum of ciphertext and comparing your results to this field. Discard
the response in case of non-matching checksum values, and perform a limited
number of retries. A persistent mismatch may indicate an issue in your
computation of the CRC32C checksum. Note: This field is defined as int64
for reasons of compatibility across different languages. However, it is a
non-negative integer, which will never exceed 2^32-1, and can be safely
downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value ciphertext_crc32c = 4;</code>
@param int|string|null $var
@return $this | setCiphertextCrc32CUnwrapped | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getInitializationVectorCrc32C()
{
return $this->initialization_vector_crc32c;
} | Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector and comparing your results to
this field. Discard the response in case of non-matching checksum values,
and perform a limited number of retries. A persistent mismatch may indicate
an issue in your computation of the CRC32C checksum. Note: This field is
defined as int64 for reasons of compatibility across different languages.
However, it is a non-negative integer, which will never exceed 2^32-1, and
can be safely downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value initialization_vector_crc32c = 5;</code>
@return \Google\Protobuf\Int64Value|null | getInitializationVectorCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getInitializationVectorCrc32CUnwrapped()
{
return $this->readWrapperValue("initialization_vector_crc32c");
} | Returns the unboxed value from <code>getInitializationVectorCrc32C()</code>
Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector and comparing your results to
this field. Discard the response in case of non-matching checksum values,
and perform a limited number of retries. A persistent mismatch may indicate
an issue in your computation of the CRC32C checksum. Note: This field is
defined as int64 for reasons of compatibility across different languages.
However, it is a non-negative integer, which will never exceed 2^32-1, and
can be safely downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value initialization_vector_crc32c = 5;</code>
@return int|string|null | getInitializationVectorCrc32CUnwrapped | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setInitializationVectorCrc32C($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Int64Value::class);
$this->initialization_vector_crc32c = $var;
return $this;
} | Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector and comparing your results to
this field. Discard the response in case of non-matching checksum values,
and perform a limited number of retries. A persistent mismatch may indicate
an issue in your computation of the CRC32C checksum. Note: This field is
defined as int64 for reasons of compatibility across different languages.
However, it is a non-negative integer, which will never exceed 2^32-1, and
can be safely downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value initialization_vector_crc32c = 5;</code>
@param \Google\Protobuf\Int64Value $var
@return $this | setInitializationVectorCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setInitializationVectorCrc32CUnwrapped($var)
{
$this->writeWrapperValue("initialization_vector_crc32c", $var);
return $this;} | Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.
Integrity verification field. A CRC32C checksum of the returned
[RawEncryptResponse.initialization_vector][google.cloud.kms.v1.RawEncryptResponse.initialization_vector].
An integrity check of initialization_vector can be performed by computing
the CRC32C checksum of initialization_vector and comparing your results to
this field. Discard the response in case of non-matching checksum values,
and perform a limited number of retries. A persistent mismatch may indicate
an issue in your computation of the CRC32C checksum. Note: This field is
defined as int64 for reasons of compatibility across different languages.
However, it is a non-negative integer, which will never exceed 2^32-1, and
can be safely downconverted to uint32 in languages that support this type.
Generated from protobuf field <code>.google.protobuf.Int64Value initialization_vector_crc32c = 5;</code>
@param int|string|null $var
@return $this | setInitializationVectorCrc32CUnwrapped | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getVerifiedPlaintextCrc32C()
{
return $this->verified_plaintext_crc32c;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of the plaintext. A false value of this
field indicates either that
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_plaintext_crc32c = 6;</code>
@return bool | getVerifiedPlaintextCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setVerifiedPlaintextCrc32C($var)
{
GPBUtil::checkBool($var);
$this->verified_plaintext_crc32c = $var;
return $this;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of the plaintext. A false value of this
field indicates either that
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.plaintext_crc32c][google.cloud.kms.v1.RawEncryptRequest.plaintext_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_plaintext_crc32c = 6;</code>
@param bool $var
@return $this | setVerifiedPlaintextCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getVerifiedAdditionalAuthenticatedDataCrc32C()
{
return $this->verified_additional_authenticated_data_crc32c;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of additional_authenticated_data. A false
value of this field indicates either that //
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_additional_authenticated_data_crc32c = 7;</code>
@return bool | getVerifiedAdditionalAuthenticatedDataCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setVerifiedAdditionalAuthenticatedDataCrc32C($var)
{
GPBUtil::checkBool($var);
$this->verified_additional_authenticated_data_crc32c = $var;
return $this;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of additional_authenticated_data. A false
value of this field indicates either that //
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.additional_authenticated_data_crc32c][google.cloud.kms.v1.RawEncryptRequest.additional_authenticated_data_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_additional_authenticated_data_crc32c = 7;</code>
@param bool $var
@return $this | setVerifiedAdditionalAuthenticatedDataCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getVerifiedInitializationVectorCrc32C()
{
return $this->verified_initialization_vector_crc32c;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of initialization_vector. A false value of
this field indicates either that
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_initialization_vector_crc32c = 10;</code>
@return bool | getVerifiedInitializationVectorCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setVerifiedInitializationVectorCrc32C($var)
{
GPBUtil::checkBool($var);
$this->verified_initialization_vector_crc32c = $var;
return $this;
} | Integrity verification field. A flag indicating whether
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
was received by
[KeyManagementService][google.cloud.kms.v1.KeyManagementService] and used
for the integrity verification of initialization_vector. A false value of
this field indicates either that
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
was left unset or that it was not delivered to
[KeyManagementService][google.cloud.kms.v1.KeyManagementService]. If you've
set
[RawEncryptRequest.initialization_vector_crc32c][google.cloud.kms.v1.RawEncryptRequest.initialization_vector_crc32c]
but this field is still false, discard the response and perform a limited
number of retries.
Generated from protobuf field <code>bool verified_initialization_vector_crc32c = 10;</code>
@param bool $var
@return $this | setVerifiedInitializationVectorCrc32C | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | The resource name of the
[CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
encryption. Check this field to verify that the intended resource was used
for encryption.
Generated from protobuf field <code>string name = 8;</code>
@return string | getName | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | The resource name of the
[CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
encryption. Check this field to verify that the intended resource was used
for encryption.
Generated from protobuf field <code>string name = 8;</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getProtectionLevel()
{
return $this->protection_level;
} | The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
[CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
encryption.
Generated from protobuf field <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 9;</code>
@return int | getProtectionLevel | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function setProtectionLevel($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Kms\V1\ProtectionLevel::class);
$this->protection_level = $var;
return $this;
} | The [ProtectionLevel][google.cloud.kms.v1.ProtectionLevel] of the
[CryptoKeyVersion][google.cloud.kms.v1.CryptoKeyVersion] used in
encryption.
Generated from protobuf field <code>.google.cloud.kms.v1.ProtectionLevel protection_level = 9;</code>
@param int $var
@return $this | setProtectionLevel | php | googleapis/google-cloud-php | Kms/src/V1/RawEncryptResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Kms/src/V1/RawEncryptResponse.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | The resource name of the clip, in the following format:
`projects/{project}/locations/{location}/channels/{c}/clips/{clipId}`.
`{clipId}` is a user-specified resource id that conforms to the following
criteria:
1. 1 character minimum, 63 characters maximum
2. Only contains letters, digits, underscores, and hyphens
Generated from protobuf field <code>string name = 1;</code>
@return string | getName | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | The resource name of the clip, in the following format:
`projects/{project}/locations/{location}/channels/{c}/clips/{clipId}`.
`{clipId}` is a user-specified resource id that conforms to the following
criteria:
1. 1 character minimum, 63 characters maximum
2. Only contains letters, digits, underscores, and hyphens
Generated from protobuf field <code>string name = 1;</code>
@param string $var
@return $this | setName | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getCreateTime()
{
return $this->create_time;
} | Output only. The creation timestamp of the clip resource.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getCreateTime | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setCreateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->create_time = $var;
return $this;
} | Output only. The creation timestamp of the clip resource.
Generated from protobuf field <code>.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setCreateTime | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getStartTime()
{
return $this->start_time;
} | Output only. The timestamp when the clip request starts to be processed.
Generated from protobuf field <code>.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getStartTime | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setStartTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->start_time = $var;
return $this;
} | Output only. The timestamp when the clip request starts to be processed.
Generated from protobuf field <code>.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Protobuf\Timestamp $var
@return $this | setStartTime | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getUpdateTime()
{
return $this->update_time;
} | Output only. The update timestamp of the clip resource.
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 | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setUpdateTime($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\Timestamp::class);
$this->update_time = $var;
return $this;
} | Output only. The update timestamp of the clip resource.
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 | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getLabels()
{
return $this->labels;
} | The labels associated with this resource. Each label is a key-value pair.
Generated from protobuf field <code>map<string, string> labels = 5;</code>
@return \Google\Protobuf\Internal\MapField | getLabels | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setLabels($var)
{
$arr = GPBUtil::checkMapField($var, \Google\Protobuf\Internal\GPBType::STRING, \Google\Protobuf\Internal\GPBType::STRING);
$this->labels = $arr;
return $this;
} | The labels associated with this resource. Each label is a key-value pair.
Generated from protobuf field <code>map<string, string> labels = 5;</code>
@param array|\Google\Protobuf\Internal\MapField $var
@return $this | setLabels | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getState()
{
return $this->state;
} | Output only. The state of the clip.
Generated from protobuf field <code>.google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getState | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Video\LiveStream\V1\Clip\State::class);
$this->state = $var;
return $this;
} | Output only. The state of the clip.
Generated from protobuf field <code>.google.cloud.video.livestream.v1.Clip.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setState | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getOutputUri()
{
return $this->output_uri;
} | Specify the `output_uri` to determine where to place the clip segments and
clip manifest files in Cloud Storage. The manifests specified in
`clip_manifests` fields will be placed under this URI. The exact URI of the
generated manifests will be provided in `clip_manifests.output_uri` for
each manifest.
Example:
"output_uri": "gs://my-bucket/clip-outputs"
"clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8"
Generated from protobuf field <code>string output_uri = 7;</code>
@return string | getOutputUri | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setOutputUri($var)
{
GPBUtil::checkString($var, True);
$this->output_uri = $var;
return $this;
} | Specify the `output_uri` to determine where to place the clip segments and
clip manifest files in Cloud Storage. The manifests specified in
`clip_manifests` fields will be placed under this URI. The exact URI of the
generated manifests will be provided in `clip_manifests.output_uri` for
each manifest.
Example:
"output_uri": "gs://my-bucket/clip-outputs"
"clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8"
Generated from protobuf field <code>string output_uri = 7;</code>
@param string $var
@return $this | setOutputUri | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getError()
{
return $this->error;
} | Output only. An error object that describes the reason for the failure.
This property only presents when `state` is `FAILED`.
Generated from protobuf field <code>.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Rpc\Status|null | getError | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setError($var)
{
GPBUtil::checkMessage($var, \Google\Rpc\Status::class);
$this->error = $var;
return $this;
} | Output only. An error object that describes the reason for the failure.
This property only presents when `state` is `FAILED`.
Generated from protobuf field <code>.google.rpc.Status error = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param \Google\Rpc\Status $var
@return $this | setError | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getSlices()
{
return $this->slices;
} | The specified ranges of segments to generate a clip.
Generated from protobuf field <code>repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;</code>
@return \Google\Protobuf\Internal\RepeatedField | getSlices | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setSlices($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Video\LiveStream\V1\Clip\Slice::class);
$this->slices = $arr;
return $this;
} | The specified ranges of segments to generate a clip.
Generated from protobuf field <code>repeated .google.cloud.video.livestream.v1.Clip.Slice slices = 10;</code>
@param array<\Google\Cloud\Video\LiveStream\V1\Clip\Slice>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setSlices | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getClipManifests()
{
return $this->clip_manifests;
} | Required. A list of clip manifests. Currently only one clip manifest is
allowed.
Generated from protobuf field <code>repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Protobuf\Internal\RepeatedField | getClipManifests | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function setClipManifests($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\Video\LiveStream\V1\Clip\ClipManifest::class);
$this->clip_manifests = $arr;
return $this;
} | Required. A list of clip manifests. Currently only one clip manifest is
allowed.
Generated from protobuf field <code>repeated .google.cloud.video.livestream.v1.Clip.ClipManifest clip_manifests = 12 [(.google.api.field_behavior) = REQUIRED];</code>
@param array<\Google\Cloud\Video\LiveStream\V1\Clip\ClipManifest>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setClipManifests | php | googleapis/google-cloud-php | VideoLiveStream/src/V1/Clip.php | https://github.com/googleapis/google-cloud-php/blob/master/VideoLiveStream/src/V1/Clip.php | Apache-2.0 |
public function getGlobalSetLabelsRequestResource()
{
return $this->global_set_labels_request_resource;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.GlobalSetLabelsRequest global_set_labels_request_resource = 319917189 [(.google.api.field_behavior) = REQUIRED];</code>
@return \Google\Cloud\Compute\V1\GlobalSetLabelsRequest|null | getGlobalSetLabelsRequestResource | php | googleapis/google-cloud-php | Compute/src/V1/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.php | Apache-2.0 |
public function setGlobalSetLabelsRequestResource($var)
{
GPBUtil::checkMessage($var, \Google\Cloud\Compute\V1\GlobalSetLabelsRequest::class);
$this->global_set_labels_request_resource = $var;
return $this;
} | The body resource for this request
Generated from protobuf field <code>.google.cloud.compute.v1.GlobalSetLabelsRequest global_set_labels_request_resource = 319917189 [(.google.api.field_behavior) = REQUIRED];</code>
@param \Google\Cloud\Compute\V1\GlobalSetLabelsRequest $var
@return $this | setGlobalSetLabelsRequestResource | php | googleapis/google-cloud-php | Compute/src/V1/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.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/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.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/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.php | Apache-2.0 |
public function getResource()
{
return $this->resource;
} | Name or id of the resource for this request.
Generated from protobuf field <code>string resource = 195806222 [(.google.api.field_behavior) = REQUIRED];</code>
@return string | getResource | php | googleapis/google-cloud-php | Compute/src/V1/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.php | Apache-2.0 |
public function setResource($var)
{
GPBUtil::checkString($var, True);
$this->resource = $var;
return $this;
} | Name or id of the resource for this request.
Generated from protobuf field <code>string resource = 195806222 [(.google.api.field_behavior) = REQUIRED];</code>
@param string $var
@return $this | setResource | php | googleapis/google-cloud-php | Compute/src/V1/SetLabelsMachineImageRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/Compute/src/V1/SetLabelsMachineImageRequest.php | Apache-2.0 |
public function getParent()
{
return $this->parent;
} | Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
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 | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function setParent($var)
{
GPBUtil::checkString($var, True);
$this->parent = $var;
return $this;
} | Required. The name of the entry group that contains the entries to list.
Can be provided in URL format.
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 | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function getPageSize()
{
return $this->page_size;
} | The maximum number of items to return. Default is 10. Maximum limit is
1000. Throws an invalid argument if `page_size` is more than 1000.
Generated from protobuf field <code>int32 page_size = 2;</code>
@return int | getPageSize | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function setPageSize($var)
{
GPBUtil::checkInt32($var);
$this->page_size = $var;
return $this;
} | The maximum number of items to return. Default is 10. Maximum limit is
1000. Throws an invalid argument if `page_size` is more than 1000.
Generated from protobuf field <code>int32 page_size = 2;</code>
@param int $var
@return $this | setPageSize | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function getPageToken()
{
return $this->page_token;
} | Pagination token that specifies the next page to return. If empty, the
first page is returned.
Generated from protobuf field <code>string page_token = 3;</code>
@return string | getPageToken | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function setPageToken($var)
{
GPBUtil::checkString($var, True);
$this->page_token = $var;
return $this;
} | Pagination token that specifies the next page to return. If empty, the
first page is returned.
Generated from protobuf field <code>string page_token = 3;</code>
@param string $var
@return $this | setPageToken | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function getReadMask()
{
return $this->read_mask;
} | The fields to return for each entry. If empty or omitted, all
fields are returned.
For example, to return a list of entries with only the `name` field,
set `read_mask` to only one path with the `name` value.
Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 4;</code>
@return \Google\Protobuf\FieldMask|null | getReadMask | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function setReadMask($var)
{
GPBUtil::checkMessage($var, \Google\Protobuf\FieldMask::class);
$this->read_mask = $var;
return $this;
} | The fields to return for each entry. If empty or omitted, all
fields are returned.
For example, to return a list of entries with only the `name` field,
set `read_mask` to only one path with the `name` value.
Generated from protobuf field <code>.google.protobuf.FieldMask read_mask = 4;</code>
@param \Google\Protobuf\FieldMask $var
@return $this | setReadMask | php | googleapis/google-cloud-php | DataCatalog/src/V1/ListEntriesRequest.php | https://github.com/googleapis/google-cloud-php/blob/master/DataCatalog/src/V1/ListEntriesRequest.php | Apache-2.0 |
public function getResourceDescriptors()
{
return $this->resource_descriptors;
} | The monitored resource descriptors that are available to this project
and that match `filter`, if present.
Generated from protobuf field <code>repeated .google.api.MonitoredResourceDescriptor resource_descriptors = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getResourceDescriptors | php | googleapis/google-cloud-php | Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | Apache-2.0 |
public function setResourceDescriptors($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Api\MonitoredResourceDescriptor::class);
$this->resource_descriptors = $arr;
return $this;
} | The monitored resource descriptors that are available to this project
and that match `filter`, if present.
Generated from protobuf field <code>repeated .google.api.MonitoredResourceDescriptor resource_descriptors = 1;</code>
@param array<\Google\Api\MonitoredResourceDescriptor>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setResourceDescriptors | php | googleapis/google-cloud-php | Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as `page_token` in the next call to this method.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | If there are more results than have been returned, then this field is set
to a non-empty value. To see the additional results,
use that value as `page_token` in the next call to this method.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Monitoring/src/V3/ListMonitoredResourceDescriptorsResponse.php | Apache-2.0 |
public function getPrivateConnections()
{
return $this->private_connections;
} | List of private connections.
Generated from protobuf field <code>repeated .google.cloud.clouddms.v1.PrivateConnection private_connections = 1;</code>
@return \Google\Protobuf\Internal\RepeatedField | getPrivateConnections | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function setPrivateConnections($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Google\Cloud\CloudDms\V1\PrivateConnection::class);
$this->private_connections = $arr;
return $this;
} | List of private connections.
Generated from protobuf field <code>repeated .google.cloud.clouddms.v1.PrivateConnection private_connections = 1;</code>
@param array<\Google\Cloud\CloudDms\V1\PrivateConnection>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setPrivateConnections | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function getNextPageToken()
{
return $this->next_page_token;
} | A token which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@return string | getNextPageToken | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function setNextPageToken($var)
{
GPBUtil::checkString($var, True);
$this->next_page_token = $var;
return $this;
} | A token which can be sent as `page_token` to retrieve the next page.
If this field is omitted, there are no subsequent pages.
Generated from protobuf field <code>string next_page_token = 2;</code>
@param string $var
@return $this | setNextPageToken | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function getUnreachable()
{
return $this->unreachable;
} | Locations that could not be reached.
Generated from protobuf field <code>repeated string unreachable = 3;</code>
@return \Google\Protobuf\Internal\RepeatedField | getUnreachable | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function setUnreachable($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->unreachable = $arr;
return $this;
} | Locations that could not be reached.
Generated from protobuf field <code>repeated string unreachable = 3;</code>
@param array<string>|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setUnreachable | php | googleapis/google-cloud-php | Dms/src/V1/ListPrivateConnectionsResponse.php | https://github.com/googleapis/google-cloud-php/blob/master/Dms/src/V1/ListPrivateConnectionsResponse.php | Apache-2.0 |
public function getName()
{
return $this->name;
} | Identifier. The version name is in the format:
'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'.
Generated from protobuf field <code>string name = 1 [(.google.api.field_behavior) = IDENTIFIER];</code>
@return string | getName | php | googleapis/google-cloud-php | Config/src/V1/TerraformVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/Config/src/V1/TerraformVersion.php | Apache-2.0 |
public function setName($var)
{
GPBUtil::checkString($var, True);
$this->name = $var;
return $this;
} | Identifier. The version name is in the format:
'projects/{project_id}/locations/{location}/terraformVersions/{terraform_version}'.
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 | Config/src/V1/TerraformVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/Config/src/V1/TerraformVersion.php | Apache-2.0 |
public function getState()
{
return $this->state;
} | Output only. The state of the version, ACTIVE, DEPRECATED or OBSOLETE.
Generated from protobuf field <code>.google.cloud.config.v1.TerraformVersion.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return int | getState | php | googleapis/google-cloud-php | Config/src/V1/TerraformVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/Config/src/V1/TerraformVersion.php | Apache-2.0 |
public function setState($var)
{
GPBUtil::checkEnum($var, \Google\Cloud\Config\V1\TerraformVersion\State::class);
$this->state = $var;
return $this;
} | Output only. The state of the version, ACTIVE, DEPRECATED or OBSOLETE.
Generated from protobuf field <code>.google.cloud.config.v1.TerraformVersion.State state = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@param int $var
@return $this | setState | php | googleapis/google-cloud-php | Config/src/V1/TerraformVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/Config/src/V1/TerraformVersion.php | Apache-2.0 |
public function getSupportTime()
{
return $this->support_time;
} | Output only. When the version is supported.
Generated from protobuf field <code>.google.protobuf.Timestamp support_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];</code>
@return \Google\Protobuf\Timestamp|null | getSupportTime | php | googleapis/google-cloud-php | Config/src/V1/TerraformVersion.php | https://github.com/googleapis/google-cloud-php/blob/master/Config/src/V1/TerraformVersion.php | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.