inext/glastree
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

gestione documentale avanzata 1 parte

Browse Source
This commit is contained in:
Inext68
2026-05-28 09:34:28 +02:00
parent 3471befb1a
commit f2b0833b90
34482 changed files with 4312269 additions and 546 deletions
Download Patch File Download Diff File Expand all files Collapse all files
vendor/google/apiclient-services/src/Pubsub/AIInference.php
Vendored
+104
View File
@@ -0,0 +1,104 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AIInference extends \Google\Model
{
/**
* Required. An endpoint to a Vertex AI model of the form
* `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects
* /{project}/locations/{location}/publishers/{publisher}/models/{model}`.
* Vertex AI API requests will be sent to this endpoint.
*
* @var string
*/
public $endpoint;
/**
* Optional. The service account to use to make prediction requests against
* endpoints. The resource creator or updater that specifies this field must
* have `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @var string
*/
public $serviceAccountEmail;
protected $unstructuredInferenceType = UnstructuredInference::class;
protected $unstructuredInferenceDataType = '';
/**
* Required. An endpoint to a Vertex AI model of the form
* `projects/{project}/locations/{location}/endpoints/{endpoint}` or `projects
* /{project}/locations/{location}/publishers/{publisher}/models/{model}`.
* Vertex AI API requests will be sent to this endpoint.
*
* @param string $endpoint
*/
public function setEndpoint($endpoint)
{
$this->endpoint = $endpoint;
}
/**
* @return string
*/
public function getEndpoint()
{
return $this->endpoint;
}
/**
* Optional. The service account to use to make prediction requests against
* endpoints. The resource creator or updater that specifies this field must
* have `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
/**
* Optional. Requests and responses can be any arbitrary JSON object.
*
* @param UnstructuredInference $unstructuredInference
*/
public function setUnstructuredInference(UnstructuredInference $unstructuredInference)
{
$this->unstructuredInference = $unstructuredInference;
}
/**
* @return UnstructuredInference
*/
public function getUnstructuredInference()
{
return $this->unstructuredInference;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AIInference::class, 'Google_Service_Pubsub_AIInference');
vendor/google/apiclient-services/src/Pubsub/AcknowledgeRequest.php
Vendored
+53
View File
@@ -0,0 +1,53 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AcknowledgeRequest extends \Google\Collection
{
protected $collection_key = 'ackIds';
/**
* Required. The acknowledgment ID for the messages being acknowledged that
* was returned by the Pub/Sub system in the `Pull` response. Must not be
* empty.
*
* @var string[]
*/
public $ackIds;
/**
* Required. The acknowledgment ID for the messages being acknowledged that
* was returned by the Pub/Sub system in the `Pull` response. Must not be
* empty.
*
* @param string[] $ackIds
*/
public function setAckIds($ackIds)
{
$this->ackIds = $ackIds;
}
/**
* @return string[]
*/
public function getAckIds()
{
return $this->ackIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AcknowledgeRequest::class, 'Google_Service_Pubsub_AcknowledgeRequest');
vendor/google/apiclient-services/src/Pubsub/AnalyticsHubSubscriptionInfo.php
Vendored
+78
View File
@@ -0,0 +1,78 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AnalyticsHubSubscriptionInfo extends \Google\Model
{
/**
* Optional. The name of the associated Analytics Hub listing resource.
* Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_excha
* nge}/listings/{listing}"
*
* @var string
*/
public $listing;
/**
* Optional. The name of the associated Analytics Hub subscription resource.
* Pattern:
* "projects/{project}/locations/{location}/subscriptions/{subscription}"
*
* @var string
*/
public $subscription;
/**
* Optional. The name of the associated Analytics Hub listing resource.
* Pattern: "projects/{project}/locations/{location}/dataExchanges/{data_excha
* nge}/listings/{listing}"
*
* @param string $listing
*/
public function setListing($listing)
{
$this->listing = $listing;
}
/**
* @return string
*/
public function getListing()
{
return $this->listing;
}
/**
* Optional. The name of the associated Analytics Hub subscription resource.
* Pattern:
* "projects/{project}/locations/{location}/subscriptions/{subscription}"
*
* @param string $subscription
*/
public function setSubscription($subscription)
{
$this->subscription = $subscription;
}
/**
* @return string
*/
public function getSubscription()
{
return $this->subscription;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AnalyticsHubSubscriptionInfo::class, 'Google_Service_Pubsub_AnalyticsHubSubscriptionInfo');
vendor/google/apiclient-services/src/Pubsub/AvroConfig.php
Vendored
+80
View File
@@ -0,0 +1,80 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AvroConfig extends \Google\Model
{
/**
* Optional. When true, the output Cloud Storage file will be serialized using
* the topic schema, if it exists.
*
* @var bool
*/
public $useTopicSchema;
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key as additional fields in the output. The
* subscription name, message_id, and publish_time fields are put in their own
* fields while all other message properties other than data (for example, an
* ordering_key, if present) are added as entries in the attributes map.
*
* @var bool
*/
public $writeMetadata;
/**
* Optional. When true, the output Cloud Storage file will be serialized using
* the topic schema, if it exists.
*
* @param bool $useTopicSchema
*/
public function setUseTopicSchema($useTopicSchema)
{
$this->useTopicSchema = $useTopicSchema;
}
/**
* @return bool
*/
public function getUseTopicSchema()
{
return $this->useTopicSchema;
}
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key as additional fields in the output. The
* subscription name, message_id, and publish_time fields are put in their own
* fields while all other message properties other than data (for example, an
* ordering_key, if present) are added as entries in the attributes map.
*
* @param bool $writeMetadata
*/
public function setWriteMetadata($writeMetadata)
{
$this->writeMetadata = $writeMetadata;
}
/**
* @return bool
*/
public function getWriteMetadata()
{
return $this->writeMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AvroConfig::class, 'Google_Service_Pubsub_AvroConfig');
vendor/google/apiclient-services/src/Pubsub/AvroFormat.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AvroFormat extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AvroFormat::class, 'Google_Service_Pubsub_AvroFormat');
vendor/google/apiclient-services/src/Pubsub/AwsKinesis.php
Vendored
+192
View File
@@ -0,0 +1,192 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AwsKinesis extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Ingestion is active.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Permission denied encountered while consuming data from Kinesis. This can
* happen if: - The provided `aws_role_arn` does not exist or does not have
* the appropriate permissions attached. - The provided `aws_role_arn` is not
* set up properly for Identity Federation using `gcp_service_account`. - The
* Pub/Sub SA is not granted the `iam.serviceAccounts.getOpenIdToken`
* permission on `gcp_service_account`.
*/
public const STATE_KINESIS_PERMISSION_DENIED = 'KINESIS_PERMISSION_DENIED';
/**
* Permission denied encountered while publishing to the topic. This can
* happen if the Pub/Sub SA has not been granted the [appropriate publish
* permissions](https://cloud.google.com/pubsub/docs/access-
* control#pubsub.publisher)
*/
public const STATE_PUBLISH_PERMISSION_DENIED = 'PUBLISH_PERMISSION_DENIED';
/**
* The Kinesis stream does not exist.
*/
public const STATE_STREAM_NOT_FOUND = 'STREAM_NOT_FOUND';
/**
* The Kinesis consumer does not exist.
*/
public const STATE_CONSUMER_NOT_FOUND = 'CONSUMER_NOT_FOUND';
/**
* Indicates an error state where the ingestion source cannot be processed
* because the selected ingestion region is not permitted by the Regional
* Access Boundary (RAB) restrictions on the project's service account.
*/
public const STATE_CONFLICTING_REGION_CONSTRAINTS = 'CONFLICTING_REGION_CONSTRAINTS';
/**
* Required. AWS role ARN to be used for Federated Identity authentication
* with Kinesis. Check the Pub/Sub docs for how to set up this role and the
* required permissions that need to be attached to it.
*
* @var string
*/
public $awsRoleArn;
/**
* Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-
* Out mode. The consumer must be already created and ready to be used.
*
* @var string
*/
public $consumerArn;
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for the
* provided role). The `aws_role_arn` must be set up with
* `accounts.google.com:sub` equals to this service account number.
*
* @var string
*/
public $gcpServiceAccount;
/**
* Output only. An output-only field that indicates the state of the Kinesis
* ingestion source.
*
* @var string
*/
public $state;
/**
* Required. The Kinesis stream ARN to ingest data from.
*
* @var string
*/
public $streamArn;
/**
* Required. AWS role ARN to be used for Federated Identity authentication
* with Kinesis. Check the Pub/Sub docs for how to set up this role and the
* required permissions that need to be attached to it.
*
* @param string $awsRoleArn
*/
public function setAwsRoleArn($awsRoleArn)
{
$this->awsRoleArn = $awsRoleArn;
}
/**
* @return string
*/
public function getAwsRoleArn()
{
return $this->awsRoleArn;
}
/**
* Required. The Kinesis consumer ARN to used for ingestion in Enhanced Fan-
* Out mode. The consumer must be already created and ready to be used.
*
* @param string $consumerArn
*/
public function setConsumerArn($consumerArn)
{
$this->consumerArn = $consumerArn;
}
/**
* @return string
*/
public function getConsumerArn()
{
return $this->consumerArn;
}
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with Kinesis (via a `AssumeRoleWithWebIdentity` call for the
* provided role). The `aws_role_arn` must be set up with
* `accounts.google.com:sub` equals to this service account number.
*
* @param string $gcpServiceAccount
*/
public function setGcpServiceAccount($gcpServiceAccount)
{
$this->gcpServiceAccount = $gcpServiceAccount;
}
/**
* @return string
*/
public function getGcpServiceAccount()
{
return $this->gcpServiceAccount;
}
/**
* Output only. An output-only field that indicates the state of the Kinesis
* ingestion source.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, KINESIS_PERMISSION_DENIED,
* PUBLISH_PERMISSION_DENIED, STREAM_NOT_FOUND, CONSUMER_NOT_FOUND,
* CONFLICTING_REGION_CONSTRAINTS
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Required. The Kinesis stream ARN to ingest data from.
*
* @param string $streamArn
*/
public function setStreamArn($streamArn)
{
$this->streamArn = $streamArn;
}
/**
* @return string
*/
public function getStreamArn()
{
return $this->streamArn;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AwsKinesis::class, 'Google_Service_Pubsub_AwsKinesis');
vendor/google/apiclient-services/src/Pubsub/AwsMsk.php
Vendored
+186
View File
@@ -0,0 +1,186 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AwsMsk extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Ingestion is active.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Permission denied encountered while consuming data from Amazon MSK.
*/
public const STATE_MSK_PERMISSION_DENIED = 'MSK_PERMISSION_DENIED';
/**
* Permission denied encountered while publishing to the topic.
*/
public const STATE_PUBLISH_PERMISSION_DENIED = 'PUBLISH_PERMISSION_DENIED';
/**
* The provided MSK cluster wasn't found.
*/
public const STATE_CLUSTER_NOT_FOUND = 'CLUSTER_NOT_FOUND';
/**
* The provided topic wasn't found.
*/
public const STATE_TOPIC_NOT_FOUND = 'TOPIC_NOT_FOUND';
/**
* Indicates an error state where the ingestion source cannot be processed
* because the selected ingestion region is not permitted by the Regional
* Access Boundary (RAB) restrictions on the project's service account.
*/
public const STATE_CONFLICTING_REGION_CONSTRAINTS = 'CONFLICTING_REGION_CONSTRAINTS';
/**
* Required. AWS role ARN to be used for Federated Identity authentication
* with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the
* required permissions that need to be attached to it.
*
* @var string
*/
public $awsRoleArn;
/**
* Required. The Amazon Resource Name (ARN) that uniquely identifies the
* cluster.
*
* @var string
*/
public $clusterArn;
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call for
* the provided role). The `aws_role_arn` must be set up with
* `accounts.google.com:sub` equals to this service account number.
*
* @var string
*/
public $gcpServiceAccount;
/**
* Output only. An output-only field that indicates the state of the Amazon
* MSK ingestion source.
*
* @var string
*/
public $state;
/**
* Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will
* import from.
*
* @var string
*/
public $topic;
/**
* Required. AWS role ARN to be used for Federated Identity authentication
* with Amazon MSK. Check the Pub/Sub docs for how to set up this role and the
* required permissions that need to be attached to it.
*
* @param string $awsRoleArn
*/
public function setAwsRoleArn($awsRoleArn)
{
$this->awsRoleArn = $awsRoleArn;
}
/**
* @return string
*/
public function getAwsRoleArn()
{
return $this->awsRoleArn;
}
/**
* Required. The Amazon Resource Name (ARN) that uniquely identifies the
* cluster.
*
* @param string $clusterArn
*/
public function setClusterArn($clusterArn)
{
$this->clusterArn = $clusterArn;
}
/**
* @return string
*/
public function getClusterArn()
{
return $this->clusterArn;
}
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with Amazon MSK (via a `AssumeRoleWithWebIdentity` call for
* the provided role). The `aws_role_arn` must be set up with
* `accounts.google.com:sub` equals to this service account number.
*
* @param string $gcpServiceAccount
*/
public function setGcpServiceAccount($gcpServiceAccount)
{
$this->gcpServiceAccount = $gcpServiceAccount;
}
/**
* @return string
*/
public function getGcpServiceAccount()
{
return $this->gcpServiceAccount;
}
/**
* Output only. An output-only field that indicates the state of the Amazon
* MSK ingestion source.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, MSK_PERMISSION_DENIED,
* PUBLISH_PERMISSION_DENIED, CLUSTER_NOT_FOUND, TOPIC_NOT_FOUND,
* CONFLICTING_REGION_CONSTRAINTS
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Required. The name of the topic in the Amazon MSK cluster that Pub/Sub will
* import from.
*
* @param string $topic
*/
public function setTopic($topic)
{
$this->topic = $topic;
}
/**
* @return string
*/
public function getTopic()
{
return $this->topic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AwsMsk::class, 'Google_Service_Pubsub_AwsMsk');
vendor/google/apiclient-services/src/Pubsub/AzureEventHubs.php
Vendored
+255
View File
@@ -0,0 +1,255 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class AzureEventHubs extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Ingestion is active.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Permission denied encountered while consuming data from Event Hubs. This
* can happen when `client_id`, or `tenant_id` are invalid. Or the right
* permissions haven't been granted.
*/
public const STATE_EVENT_HUBS_PERMISSION_DENIED = 'EVENT_HUBS_PERMISSION_DENIED';
/**
* Permission denied encountered while publishing to the topic.
*/
public const STATE_PUBLISH_PERMISSION_DENIED = 'PUBLISH_PERMISSION_DENIED';
/**
* The provided Event Hubs namespace couldn't be found.
*/
public const STATE_NAMESPACE_NOT_FOUND = 'NAMESPACE_NOT_FOUND';
/**
* The provided Event Hub couldn't be found.
*/
public const STATE_EVENT_HUB_NOT_FOUND = 'EVENT_HUB_NOT_FOUND';
/**
* The provided Event Hubs subscription couldn't be found.
*/
public const STATE_SUBSCRIPTION_NOT_FOUND = 'SUBSCRIPTION_NOT_FOUND';
/**
* The provided Event Hubs resource group couldn't be found.
*/
public const STATE_RESOURCE_GROUP_NOT_FOUND = 'RESOURCE_GROUP_NOT_FOUND';
/**
* Indicates an error state where the ingestion source cannot be processed
* because the selected ingestion region is not permitted by the Regional
* Access Boundary (RAB) restrictions on the project's service account.
*/
public const STATE_CONFLICTING_REGION_CONSTRAINTS = 'CONFLICTING_REGION_CONSTRAINTS';
/**
* Optional. The client id of the Azure application that is being used to
* authenticate Pub/Sub.
*
* @var string
*/
public $clientId;
/**
* Optional. The name of the Event Hub.
*
* @var string
*/
public $eventHub;
/**
* Optional. The GCP service account to be used for Federated Identity
* authentication.
*
* @var string
*/
public $gcpServiceAccount;
/**
* Optional. The name of the Event Hubs namespace.
*
* @var string
*/
public $namespace;
/**
* Optional. Name of the resource group within the azure subscription.
*
* @var string
*/
public $resourceGroup;
/**
* Output only. An output-only field that indicates the state of the Event
* Hubs ingestion source.
*
* @var string
*/
public $state;
/**
* Optional. The Azure subscription id.
*
* @var string
*/
public $subscriptionId;
/**
* Optional. The tenant id of the Azure application that is being used to
* authenticate Pub/Sub.
*
* @var string
*/
public $tenantId;
/**
* Optional. The client id of the Azure application that is being used to
* authenticate Pub/Sub.
*
* @param string $clientId
*/
public function setClientId($clientId)
{
$this->clientId = $clientId;
}
/**
* @return string
*/
public function getClientId()
{
return $this->clientId;
}
/**
* Optional. The name of the Event Hub.
*
* @param string $eventHub
*/
public function setEventHub($eventHub)
{
$this->eventHub = $eventHub;
}
/**
* @return string
*/
public function getEventHub()
{
return $this->eventHub;
}
/**
* Optional. The GCP service account to be used for Federated Identity
* authentication.
*
* @param string $gcpServiceAccount
*/
public function setGcpServiceAccount($gcpServiceAccount)
{
$this->gcpServiceAccount = $gcpServiceAccount;
}
/**
* @return string
*/
public function getGcpServiceAccount()
{
return $this->gcpServiceAccount;
}
/**
* Optional. The name of the Event Hubs namespace.
*
* @param string $namespace
*/
public function setNamespace($namespace)
{
$this->namespace = $namespace;
}
/**
* @return string
*/
public function getNamespace()
{
return $this->namespace;
}
/**
* Optional. Name of the resource group within the azure subscription.
*
* @param string $resourceGroup
*/
public function setResourceGroup($resourceGroup)
{
$this->resourceGroup = $resourceGroup;
}
/**
* @return string
*/
public function getResourceGroup()
{
return $this->resourceGroup;
}
/**
* Output only. An output-only field that indicates the state of the Event
* Hubs ingestion source.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, EVENT_HUBS_PERMISSION_DENIED,
* PUBLISH_PERMISSION_DENIED, NAMESPACE_NOT_FOUND, EVENT_HUB_NOT_FOUND,
* SUBSCRIPTION_NOT_FOUND, RESOURCE_GROUP_NOT_FOUND,
* CONFLICTING_REGION_CONSTRAINTS
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. The Azure subscription id.
*
* @param string $subscriptionId
*/
public function setSubscriptionId($subscriptionId)
{
$this->subscriptionId = $subscriptionId;
}
/**
* @return string
*/
public function getSubscriptionId()
{
return $this->subscriptionId;
}
/**
* Optional. The tenant id of the Azure application that is being used to
* authenticate Pub/Sub.
*
* @param string $tenantId
*/
public function setTenantId($tenantId)
{
$this->tenantId = $tenantId;
}
/**
* @return string
*/
public function getTenantId()
{
return $this->tenantId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(AzureEventHubs::class, 'Google_Service_Pubsub_AzureEventHubs');
vendor/google/apiclient-services/src/Pubsub/BigQueryConfig.php
Vendored
+259
View File
@@ -0,0 +1,259 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class BigQueryConfig extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The subscription can actively send messages to BigQuery
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Cannot write to the BigQuery table because of permission denied errors.
* This can happen if - Pub/Sub SA has not been granted the [appropriate
* BigQuery IAM permissions](https://cloud.google.com/pubsub/docs/create-
* subscription#assign_bigquery_service_account) - bigquery.googleapis.com API
* is not enabled for the project
* ([instructions](https://cloud.google.com/service-usage/docs/enable-
* disable))
*/
public const STATE_PERMISSION_DENIED = 'PERMISSION_DENIED';
/**
* Cannot write to the BigQuery table because it does not exist.
*/
public const STATE_NOT_FOUND = 'NOT_FOUND';
/**
* Cannot write to the BigQuery table due to a schema mismatch.
*/
public const STATE_SCHEMA_MISMATCH = 'SCHEMA_MISMATCH';
/**
* Cannot write to the destination because enforce_in_transit is set to true
* and the destination locations are not in the allowed regions.
*/
public const STATE_IN_TRANSIT_LOCATION_RESTRICTION = 'IN_TRANSIT_LOCATION_RESTRICTION';
/**
* Cannot write to the BigQuery table because the table is not in the same
* location as where Vertex AI models used in `message_transform`s are
* deployed.
*/
public const STATE_VERTEX_AI_LOCATION_RESTRICTION = 'VERTEX_AI_LOCATION_RESTRICTION';
/**
* Optional. When true and use_topic_schema is true, any fields that are a
* part of the topic schema that are not part of the BigQuery table schema are
* dropped when writing to BigQuery. Otherwise, the schemas must be kept in
* sync and any messages with extra fields are not written and remain in the
* subscription's backlog.
*
* @var bool
*/
public $dropUnknownFields;
/**
* Optional. The service account to use to write to BigQuery. The subscription
* creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @var string
*/
public $serviceAccountEmail;
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* @var string
*/
public $state;
/**
* Optional. The name of the table to which to write data, of the form
* {projectId}.{datasetId}.{tableId}
*
* @var string
*/
public $table;
/**
* Optional. When true, use the BigQuery table's schema as the columns to
* write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
* enabled at the same time.
*
* @var bool
*/
public $useTableSchema;
/**
* Optional. When true, use the topic's schema as the columns to write to in
* BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
* enabled at the same time.
*
* @var bool
*/
public $useTopicSchema;
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key to additional columns in the table. The
* subscription name, message_id, and publish_time fields are put in their own
* columns while all other message properties (other than data) are written to
* a JSON object in the attributes column.
*
* @var bool
*/
public $writeMetadata;
/**
* Optional. When true and use_topic_schema is true, any fields that are a
* part of the topic schema that are not part of the BigQuery table schema are
* dropped when writing to BigQuery. Otherwise, the schemas must be kept in
* sync and any messages with extra fields are not written and remain in the
* subscription's backlog.
*
* @param bool $dropUnknownFields
*/
public function setDropUnknownFields($dropUnknownFields)
{
$this->dropUnknownFields = $dropUnknownFields;
}
/**
* @return bool
*/
public function getDropUnknownFields()
{
return $this->dropUnknownFields;
}
/**
* Optional. The service account to use to write to BigQuery. The subscription
* creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, PERMISSION_DENIED, NOT_FOUND,
* SCHEMA_MISMATCH, IN_TRANSIT_LOCATION_RESTRICTION,
* VERTEX_AI_LOCATION_RESTRICTION
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. The name of the table to which to write data, of the form
* {projectId}.{datasetId}.{tableId}
*
* @param string $table
*/
public function setTable($table)
{
$this->table = $table;
}
/**
* @return string
*/
public function getTable()
{
return $this->table;
}
/**
* Optional. When true, use the BigQuery table's schema as the columns to
* write to in BigQuery. `use_table_schema` and `use_topic_schema` cannot be
* enabled at the same time.
*
* @param bool $useTableSchema
*/
public function setUseTableSchema($useTableSchema)
{
$this->useTableSchema = $useTableSchema;
}
/**
* @return bool
*/
public function getUseTableSchema()
{
return $this->useTableSchema;
}
/**
* Optional. When true, use the topic's schema as the columns to write to in
* BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be
* enabled at the same time.
*
* @param bool $useTopicSchema
*/
public function setUseTopicSchema($useTopicSchema)
{
$this->useTopicSchema = $useTopicSchema;
}
/**
* @return bool
*/
public function getUseTopicSchema()
{
return $this->useTopicSchema;
}
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key to additional columns in the table. The
* subscription name, message_id, and publish_time fields are put in their own
* columns while all other message properties (other than data) are written to
* a JSON object in the attributes column.
*
* @param bool $writeMetadata
*/
public function setWriteMetadata($writeMetadata)
{
$this->writeMetadata = $writeMetadata;
}
/**
* @return bool
*/
public function getWriteMetadata()
{
return $this->writeMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BigQueryConfig::class, 'Google_Service_Pubsub_BigQueryConfig');
vendor/google/apiclient-services/src/Pubsub/BigtableConfig.php
Vendored
+211
View File
@@ -0,0 +1,211 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class BigtableConfig extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The subscription can actively send messages to Bigtable.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Unused in the current implementation. Placeholder for future use.
*/
public const STATE_NOT_FOUND = 'NOT_FOUND';
/**
* Unused in the current implementation. Placeholder for future use.
*/
public const STATE_APP_PROFILE_MISCONFIGURED = 'APP_PROFILE_MISCONFIGURED';
/**
* Cannot write to Bigtable because of permission denied errors. This can
* happen if: - The Bigtable instance, table, or app profile does not exist. -
* The Pub/Sub service agent has not been granted the [appropriate Bigtable
* IAM permission bigtable.tables.mutateRows]({$universe.dns_names.final_docum
* entation_domain}/bigtable/docs/access-control#permissions) - The
* bigtable.googleapis.com API is not enabled for the project
* ([instructions]({$universe.dns_names.final_documentation_domain}/service-
* usage/docs/enable-disable))
*/
public const STATE_PERMISSION_DENIED = 'PERMISSION_DENIED';
/**
* Cannot write to Bigtable because of a missing column family ("data"), or if
* there is no structured row key for the subscription name + message ID, if
* because the app profile is not configured for single-cluster routing.
*/
public const STATE_SCHEMA_MISMATCH = 'SCHEMA_MISMATCH';
/**
* Cannot write to the destination because enforce_in_transit is set to true
* and the destination locations are not in the allowed regions.
*/
public const STATE_IN_TRANSIT_LOCATION_RESTRICTION = 'IN_TRANSIT_LOCATION_RESTRICTION';
/**
* Cannot write to Bigtable because the table is not in the same location as
* where Vertex AI models used in `message_transform`s are deployed.
*/
public const STATE_VERTEX_AI_LOCATION_RESTRICTION = 'VERTEX_AI_LOCATION_RESTRICTION';
/**
* Optional. The app profile to use for the Bigtable writes. If not specified,
* the "default" application profile will be used. The app profile must use
* single-cluster routing.
*
* @var string
*/
public $appProfileId;
/**
* Optional. The service account to use to write to Bigtable. The subscription
* creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @var string
*/
public $serviceAccountEmail;
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* @var string
*/
public $state;
/**
* Optional. The unique name of the table to write messages to. Values are of
* the form `projects//instances//tables/`.
*
* @var string
*/
public $table;
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key to additional columns in the table under the
* pubsub_metadata column family. The subscription name, message_id, and
* publish_time fields are put in their own columns while all other message
* properties (other than data) are written to a JSON object in the attributes
* column.
*
* @var bool
*/
public $writeMetadata;
/**
* Optional. The app profile to use for the Bigtable writes. If not specified,
* the "default" application profile will be used. The app profile must use
* single-cluster routing.
*
* @param string $appProfileId
*/
public function setAppProfileId($appProfileId)
{
$this->appProfileId = $appProfileId;
}
/**
* @return string
*/
public function getAppProfileId()
{
return $this->appProfileId;
}
/**
* Optional. The service account to use to write to Bigtable. The subscription
* creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, NOT_FOUND,
* APP_PROFILE_MISCONFIGURED, PERMISSION_DENIED, SCHEMA_MISMATCH,
* IN_TRANSIT_LOCATION_RESTRICTION, VERTEX_AI_LOCATION_RESTRICTION
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. The unique name of the table to write messages to. Values are of
* the form `projects//instances//tables/`.
*
* @param string $table
*/
public function setTable($table)
{
$this->table = $table;
}
/**
* @return string
*/
public function getTable()
{
return $this->table;
}
/**
* Optional. When true, write the subscription name, message_id, publish_time,
* attributes, and ordering_key to additional columns in the table under the
* pubsub_metadata column family. The subscription name, message_id, and
* publish_time fields are put in their own columns while all other message
* properties (other than data) are written to a JSON object in the attributes
* column.
*
* @param bool $writeMetadata
*/
public function setWriteMetadata($writeMetadata)
{
$this->writeMetadata = $writeMetadata;
}
/**
* @return bool
*/
public function getWriteMetadata()
{
return $this->writeMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(BigtableConfig::class, 'Google_Service_Pubsub_BigtableConfig');
vendor/google/apiclient-services/src/Pubsub/Binding.php
Vendored
+216
View File
@@ -0,0 +1,216 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Binding extends \Google\Collection
{
protected $collection_key = 'members';
protected $conditionType = Expr::class;
protected $conditionDataType = '';
/**
* Specifies the principals requesting access for a Google Cloud resource.
* `members` can have the following values: * `allUsers`: A special identifier
* that represents anyone who is on the internet; with or without a Google
* account. * `allAuthenticatedUsers`: A special identifier that represents
* anyone who is authenticated with a Google account or a service account.
* Does not include identities that come from external identity providers
* (IdPs) through identity federation. * `user:{emailid}`: An email address
* that represents a specific Google account. For example, `alice@example.com`
* . * `serviceAccount:{emailid}`: An email address that represents a Google
* service account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
* identifier for a [Kubernetes service
* account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-
* service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-
* kubernetes-sa]`. * `group:{emailid}`: An email address that represents a
* Google group. For example, `admins@example.com`. * `domain:{domain}`: The G
* Suite domain (primary) that represents all the users of that domain. For
* example, `google.com` or `example.com`. * `principal://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`
* : A single identity in a workforce identity pool. * `principalSet://iam.goo
* gleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
* All workforce identities in a group. * `principalSet://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attrib
* ute_value}`: All workforce identities with a specific attribute value. * `p
* rincipalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}`
* : All identities in a workforce identity pool. * `principal://iam.googleapi
* s.com/projects/{project_number}/locations/global/workloadIdentityPools/{poo
* l_id}/subject/{subject_attribute_value}`: A single identity in a workload
* identity pool. * `principalSet://iam.googleapis.com/projects/{project_numbe
* r}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A
* workload identity pool group. * `principalSet://iam.googleapis.com/projects
* /{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribut
* e.{attribute_name}/{attribute_value}`: All identities in a workload
* identity pool with a certain attribute. * `principalSet://iam.googleapis.co
* m/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id
* }`: All identities in a workload identity pool. *
* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a user that has been recently deleted. For
* example, `alice@example.com?uid=123456789012345678901`. If the user is
* recovered, this value reverts to `user:{emailid}` and the recovered user
* retains the role in the binding. *
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
* unique identifier) representing a service account that has been recently
* deleted. For example, `my-other-
* app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service
* account is undeleted, this value reverts to `serviceAccount:{emailid}` and
* the undeleted service account retains the role in the binding. *
* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a Google group that has been recently deleted. For
* example, `admins@example.com?uid=123456789012345678901`. If the group is
* recovered, this value reverts to `group:{emailid}` and the recovered group
* retains the role in the binding. * `deleted:principal://iam.googleapis.com/
* locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}
* `: Deleted single identity in a workforce identity pool. For example,
* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-
* pool-id/subject/my-subject-attribute-value`.
*
* @var string[]
*/
public $members;
/**
* Role that is assigned to the list of `members`, or principals. For example,
* `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the
* IAM roles and permissions, see the [IAM
* documentation](https://cloud.google.com/iam/docs/roles-overview). For a
* list of the available pre-defined roles, see
* [here](https://cloud.google.com/iam/docs/understanding-roles).
*
* @var string
*/
public $role;
/**
* The condition that is associated with this binding. If the condition
* evaluates to `true`, then this binding applies to the current request. If
* the condition evaluates to `false`, then this binding does not apply to the
* current request. However, a different role binding might grant the same
* role to one or more of the principals in this binding. To learn which
* resources support conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @param Expr $condition
*/
public function setCondition(Expr $condition)
{
$this->condition = $condition;
}
/**
* @return Expr
*/
public function getCondition()
{
return $this->condition;
}
/**
* Specifies the principals requesting access for a Google Cloud resource.
* `members` can have the following values: * `allUsers`: A special identifier
* that represents anyone who is on the internet; with or without a Google
* account. * `allAuthenticatedUsers`: A special identifier that represents
* anyone who is authenticated with a Google account or a service account.
* Does not include identities that come from external identity providers
* (IdPs) through identity federation. * `user:{emailid}`: An email address
* that represents a specific Google account. For example, `alice@example.com`
* . * `serviceAccount:{emailid}`: An email address that represents a Google
* service account. For example, `my-other-app@appspot.gserviceaccount.com`. *
* `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An
* identifier for a [Kubernetes service
* account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-
* service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-
* kubernetes-sa]`. * `group:{emailid}`: An email address that represents a
* Google group. For example, `admins@example.com`. * `domain:{domain}`: The G
* Suite domain (primary) that represents all the users of that domain. For
* example, `google.com` or `example.com`. * `principal://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`
* : A single identity in a workforce identity pool. * `principalSet://iam.goo
* gleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
* All workforce identities in a group. * `principalSet://iam.googleapis.com/l
* ocations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attrib
* ute_value}`: All workforce identities with a specific attribute value. * `p
* rincipalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}`
* : All identities in a workforce identity pool. * `principal://iam.googleapi
* s.com/projects/{project_number}/locations/global/workloadIdentityPools/{poo
* l_id}/subject/{subject_attribute_value}`: A single identity in a workload
* identity pool. * `principalSet://iam.googleapis.com/projects/{project_numbe
* r}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A
* workload identity pool group. * `principalSet://iam.googleapis.com/projects
* /{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribut
* e.{attribute_name}/{attribute_value}`: All identities in a workload
* identity pool with a certain attribute. * `principalSet://iam.googleapis.co
* m/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id
* }`: All identities in a workload identity pool. *
* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a user that has been recently deleted. For
* example, `alice@example.com?uid=123456789012345678901`. If the user is
* recovered, this value reverts to `user:{emailid}` and the recovered user
* retains the role in the binding. *
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
* unique identifier) representing a service account that has been recently
* deleted. For example, `my-other-
* app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service
* account is undeleted, this value reverts to `serviceAccount:{emailid}` and
* the undeleted service account retains the role in the binding. *
* `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
* identifier) representing a Google group that has been recently deleted. For
* example, `admins@example.com?uid=123456789012345678901`. If the group is
* recovered, this value reverts to `group:{emailid}` and the recovered group
* retains the role in the binding. * `deleted:principal://iam.googleapis.com/
* locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}
* `: Deleted single identity in a workforce identity pool. For example,
* `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-
* pool-id/subject/my-subject-attribute-value`.
*
* @param string[] $members
*/
public function setMembers($members)
{
$this->members = $members;
}
/**
* @return string[]
*/
public function getMembers()
{
return $this->members;
}
/**
* Role that is assigned to the list of `members`, or principals. For example,
* `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the
* IAM roles and permissions, see the [IAM
* documentation](https://cloud.google.com/iam/docs/roles-overview). For a
* list of the available pre-defined roles, see
* [here](https://cloud.google.com/iam/docs/understanding-roles).
*
* @param string $role
*/
public function setRole($role)
{
$this->role = $role;
}
/**
* @return string
*/
public function getRole()
{
return $this->role;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Binding::class, 'Google_Service_Pubsub_Binding');
vendor/google/apiclient-services/src/Pubsub/CloudStorage.php
Vendored
+225
View File
@@ -0,0 +1,225 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class CloudStorage extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Ingestion is active.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Permission denied encountered while calling the Cloud Storage API. This can
* happen if the Pub/Sub SA has not been granted the [appropriate
* permissions](https://cloud.google.com/storage/docs/access-control/iam-
* permissions): - storage.objects.list: to list the objects in a bucket. -
* storage.objects.get: to read the objects in a bucket. -
* storage.buckets.get: to verify the bucket exists.
*/
public const STATE_CLOUD_STORAGE_PERMISSION_DENIED = 'CLOUD_STORAGE_PERMISSION_DENIED';
/**
* Permission denied encountered while publishing to the topic. This can
* happen if the Pub/Sub SA has not been granted the [appropriate publish
* permissions](https://cloud.google.com/pubsub/docs/access-
* control#pubsub.publisher)
*/
public const STATE_PUBLISH_PERMISSION_DENIED = 'PUBLISH_PERMISSION_DENIED';
/**
* The provided Cloud Storage bucket doesn't exist.
*/
public const STATE_BUCKET_NOT_FOUND = 'BUCKET_NOT_FOUND';
/**
* The Cloud Storage bucket has too many objects, ingestion will be paused.
*/
public const STATE_TOO_MANY_OBJECTS = 'TOO_MANY_OBJECTS';
/**
* Indicates an error state where the ingestion source cannot be processed
* because the selected ingestion region is not permitted by the Regional
* Access Boundary (RAB) restrictions on the project's service account.
*/
public const STATE_CONFLICTING_REGION_CONSTRAINTS = 'CONFLICTING_REGION_CONSTRAINTS';
protected $avroFormatType = AvroFormat::class;
protected $avroFormatDataType = '';
/**
* Optional. Cloud Storage bucket. The bucket name must be without any prefix
* like "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @var string
*/
public $bucket;
/**
* Optional. Glob pattern used to match objects that will be ingested. If
* unset, all objects will be ingested. See the [supported patterns](https://c
* loud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-
* prefixes-using-glob).
*
* @var string
*/
public $matchGlob;
/**
* Optional. Only objects with a larger or equal creation timestamp will be
* ingested.
*
* @var string
*/
public $minimumObjectCreateTime;
protected $pubsubAvroFormatType = PubSubAvroFormat::class;
protected $pubsubAvroFormatDataType = '';
/**
* Output only. An output-only field that indicates the state of the Cloud
* Storage ingestion source.
*
* @var string
*/
public $state;
protected $textFormatType = TextFormat::class;
protected $textFormatDataType = '';
/**
* Optional. Data from Cloud Storage will be interpreted in Avro format.
*
* @param AvroFormat $avroFormat
*/
public function setAvroFormat(AvroFormat $avroFormat)
{
$this->avroFormat = $avroFormat;
}
/**
* @return AvroFormat
*/
public function getAvroFormat()
{
return $this->avroFormat;
}
/**
* Optional. Cloud Storage bucket. The bucket name must be without any prefix
* like "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @param string $bucket
*/
public function setBucket($bucket)
{
$this->bucket = $bucket;
}
/**
* @return string
*/
public function getBucket()
{
return $this->bucket;
}
/**
* Optional. Glob pattern used to match objects that will be ingested. If
* unset, all objects will be ingested. See the [supported patterns](https://c
* loud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-
* prefixes-using-glob).
*
* @param string $matchGlob
*/
public function setMatchGlob($matchGlob)
{
$this->matchGlob = $matchGlob;
}
/**
* @return string
*/
public function getMatchGlob()
{
return $this->matchGlob;
}
/**
* Optional. Only objects with a larger or equal creation timestamp will be
* ingested.
*
* @param string $minimumObjectCreateTime
*/
public function setMinimumObjectCreateTime($minimumObjectCreateTime)
{
$this->minimumObjectCreateTime = $minimumObjectCreateTime;
}
/**
* @return string
*/
public function getMinimumObjectCreateTime()
{
return $this->minimumObjectCreateTime;
}
/**
* Optional. It will be assumed data from Cloud Storage was written via [Cloud
* Storage subscriptions](https://cloud.google.com/pubsub/docs/cloudstorage).
*
* @param PubSubAvroFormat $pubsubAvroFormat
*/
public function setPubsubAvroFormat(PubSubAvroFormat $pubsubAvroFormat)
{
$this->pubsubAvroFormat = $pubsubAvroFormat;
}
/**
* @return PubSubAvroFormat
*/
public function getPubsubAvroFormat()
{
return $this->pubsubAvroFormat;
}
/**
* Output only. An output-only field that indicates the state of the Cloud
* Storage ingestion source.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE,
* CLOUD_STORAGE_PERMISSION_DENIED, PUBLISH_PERMISSION_DENIED,
* BUCKET_NOT_FOUND, TOO_MANY_OBJECTS, CONFLICTING_REGION_CONSTRAINTS
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. Data from Cloud Storage will be interpreted as text.
*
* @param TextFormat $textFormat
*/
public function setTextFormat(TextFormat $textFormat)
{
$this->textFormat = $textFormat;
}
/**
* @return TextFormat
*/
public function getTextFormat()
{
return $this->textFormat;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CloudStorage::class, 'Google_Service_Pubsub_CloudStorage');
vendor/google/apiclient-services/src/Pubsub/CloudStorageConfig.php
Vendored
+339
View File
@@ -0,0 +1,339 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class CloudStorageConfig extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The subscription can actively send messages to Cloud Storage.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Cannot write to the Cloud Storage bucket because of permission denied
* errors.
*/
public const STATE_PERMISSION_DENIED = 'PERMISSION_DENIED';
/**
* Cannot write to the Cloud Storage bucket because it does not exist.
*/
public const STATE_NOT_FOUND = 'NOT_FOUND';
/**
* Cannot write to the destination because enforce_in_transit is set to true
* and the destination locations are not in the allowed regions.
*/
public const STATE_IN_TRANSIT_LOCATION_RESTRICTION = 'IN_TRANSIT_LOCATION_RESTRICTION';
/**
* Cannot write to the Cloud Storage bucket due to an incompatibility between
* the topic schema and subscription settings.
*/
public const STATE_SCHEMA_MISMATCH = 'SCHEMA_MISMATCH';
/**
* Cannot write to the Cloud Storage bucket because the bucket is not in the
* same location as where Vertex AI models used in `message_transform`s are
* deployed.
*/
public const STATE_VERTEX_AI_LOCATION_RESTRICTION = 'VERTEX_AI_LOCATION_RESTRICTION';
protected $avroConfigType = AvroConfig::class;
protected $avroConfigDataType = '';
/**
* Required. User-provided name for the Cloud Storage bucket. The bucket must
* be created by the user. The bucket name must be without any prefix like
* "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @var string
*/
public $bucket;
/**
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-
* subscription#file_names).
*
* @var string
*/
public $filenameDatetimeFormat;
/**
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
* @var string
*/
public $filenamePrefix;
/**
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
* @var string
*/
public $filenameSuffix;
/**
* Optional. The maximum bytes that can be written to a Cloud Storage file
* before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
* be exceeded in cases where messages are larger than the limit.
*
* @var string
*/
public $maxBytes;
/**
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgment deadline.
*
* @var string
*/
public $maxDuration;
/**
* Optional. The maximum number of messages that can be written to a Cloud
* Storage file before a new file is created. Min 1000 messages.
*
* @var string
*/
public $maxMessages;
/**
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @var string
*/
public $serviceAccountEmail;
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* @var string
*/
public $state;
protected $textConfigType = TextConfig::class;
protected $textConfigDataType = '';
/**
* Optional. If set, message data will be written to Cloud Storage in Avro
* format.
*
* @param AvroConfig $avroConfig
*/
public function setAvroConfig(AvroConfig $avroConfig)
{
$this->avroConfig = $avroConfig;
}
/**
* @return AvroConfig
*/
public function getAvroConfig()
{
return $this->avroConfig;
}
/**
* Required. User-provided name for the Cloud Storage bucket. The bucket must
* be created by the user. The bucket name must be without any prefix like
* "gs://". See the [bucket naming requirements]
* (https://cloud.google.com/storage/docs/buckets#naming).
*
* @param string $bucket
*/
public function setBucket($bucket)
{
$this->bucket = $bucket;
}
/**
* @return string
*/
public function getBucket()
{
return $this->bucket;
}
/**
* Optional. User-provided format string specifying how to represent datetimes
* in Cloud Storage filenames. See the [datetime format
* guidance](https://cloud.google.com/pubsub/docs/create-cloudstorage-
* subscription#file_names).
*
* @param string $filenameDatetimeFormat
*/
public function setFilenameDatetimeFormat($filenameDatetimeFormat)
{
$this->filenameDatetimeFormat = $filenameDatetimeFormat;
}
/**
* @return string
*/
public function getFilenameDatetimeFormat()
{
return $this->filenameDatetimeFormat;
}
/**
* Optional. User-provided prefix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
*
* @param string $filenamePrefix
*/
public function setFilenamePrefix($filenamePrefix)
{
$this->filenamePrefix = $filenamePrefix;
}
/**
* @return string
*/
public function getFilenamePrefix()
{
return $this->filenamePrefix;
}
/**
* Optional. User-provided suffix for Cloud Storage filename. See the [object
* naming requirements](https://cloud.google.com/storage/docs/objects#naming).
* Must not end in "/".
*
* @param string $filenameSuffix
*/
public function setFilenameSuffix($filenameSuffix)
{
$this->filenameSuffix = $filenameSuffix;
}
/**
* @return string
*/
public function getFilenameSuffix()
{
return $this->filenameSuffix;
}
/**
* Optional. The maximum bytes that can be written to a Cloud Storage file
* before a new file is created. Min 1 KB, max 10 GiB. The max_bytes limit may
* be exceeded in cases where messages are larger than the limit.
*
* @param string $maxBytes
*/
public function setMaxBytes($maxBytes)
{
$this->maxBytes = $maxBytes;
}
/**
* @return string
*/
public function getMaxBytes()
{
return $this->maxBytes;
}
/**
* Optional. The maximum duration that can elapse before a new Cloud Storage
* file is created. Min 1 minute, max 10 minutes, default 5 minutes. May not
* exceed the subscription's acknowledgment deadline.
*
* @param string $maxDuration
*/
public function setMaxDuration($maxDuration)
{
$this->maxDuration = $maxDuration;
}
/**
* @return string
*/
public function getMaxDuration()
{
return $this->maxDuration;
}
/**
* Optional. The maximum number of messages that can be written to a Cloud
* Storage file before a new file is created. Min 1000 messages.
*
* @param string $maxMessages
*/
public function setMaxMessages($maxMessages)
{
$this->maxMessages = $maxMessages;
}
/**
* @return string
*/
public function getMaxMessages()
{
return $this->maxMessages;
}
/**
* Optional. The service account to use to write to Cloud Storage. The
* subscription creator or updater that specifies this field must have
* `iam.serviceAccounts.actAs` permission on the service account. If not
* specified, the Pub/Sub [service
* agent](https://cloud.google.com/iam/docs/service-agents),
* service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
/**
* Output only. An output-only field that indicates whether or not the
* subscription can receive messages.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, PERMISSION_DENIED, NOT_FOUND,
* IN_TRANSIT_LOCATION_RESTRICTION, SCHEMA_MISMATCH,
* VERTEX_AI_LOCATION_RESTRICTION
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. If set, message data will be written to Cloud Storage in text
* format.
*
* @param TextConfig $textConfig
*/
public function setTextConfig(TextConfig $textConfig)
{
$this->textConfig = $textConfig;
}
/**
* @return TextConfig
*/
public function getTextConfig()
{
return $this->textConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CloudStorageConfig::class, 'Google_Service_Pubsub_CloudStorageConfig');
vendor/google/apiclient-services/src/Pubsub/CommitSchemaRequest.php
Vendored
+44
View File
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class CommitSchemaRequest extends \Google\Model
{
protected $schemaType = Schema::class;
protected $schemaDataType = '';
/**
* Required. The schema revision to commit.
*
* @param Schema $schema
*/
public function setSchema(Schema $schema)
{
$this->schema = $schema;
}
/**
* @return Schema
*/
public function getSchema()
{
return $this->schema;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CommitSchemaRequest::class, 'Google_Service_Pubsub_CommitSchemaRequest');
vendor/google/apiclient-services/src/Pubsub/ConfluentCloud.php
Vendored
+211
View File
@@ -0,0 +1,211 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ConfluentCloud extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* Ingestion is active.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Permission denied encountered while consuming data from Confluent Cloud.
*/
public const STATE_CONFLUENT_CLOUD_PERMISSION_DENIED = 'CONFLUENT_CLOUD_PERMISSION_DENIED';
/**
* Permission denied encountered while publishing to the topic.
*/
public const STATE_PUBLISH_PERMISSION_DENIED = 'PUBLISH_PERMISSION_DENIED';
/**
* The provided bootstrap server address is unreachable.
*/
public const STATE_UNREACHABLE_BOOTSTRAP_SERVER = 'UNREACHABLE_BOOTSTRAP_SERVER';
/**
* The provided cluster wasn't found.
*/
public const STATE_CLUSTER_NOT_FOUND = 'CLUSTER_NOT_FOUND';
/**
* The provided topic wasn't found.
*/
public const STATE_TOPIC_NOT_FOUND = 'TOPIC_NOT_FOUND';
/**
* Indicates an error state where the ingestion source cannot be processed
* because the selected ingestion region is not permitted by the Regional
* Access Boundary (RAB) restrictions on the project's service account.
*/
public const STATE_CONFLICTING_REGION_CONSTRAINTS = 'CONFLICTING_REGION_CONSTRAINTS';
/**
* Required. The address of the bootstrap server. The format is url:port.
*
* @var string
*/
public $bootstrapServer;
/**
* Required. The id of the cluster.
*
* @var string
*/
public $clusterId;
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with `identity_pool_id`.
*
* @var string
*/
public $gcpServiceAccount;
/**
* Required. The id of the identity pool to be used for Federated Identity
* authentication with Confluent Cloud. See
* https://docs.confluent.io/cloud/current/security/authenticate/workload-
* identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-
* pools.
*
* @var string
*/
public $identityPoolId;
/**
* Output only. An output-only field that indicates the state of the Confluent
* Cloud ingestion source.
*
* @var string
*/
public $state;
/**
* Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub
* will import from.
*
* @var string
*/
public $topic;
/**
* Required. The address of the bootstrap server. The format is url:port.
*
* @param string $bootstrapServer
*/
public function setBootstrapServer($bootstrapServer)
{
$this->bootstrapServer = $bootstrapServer;
}
/**
* @return string
*/
public function getBootstrapServer()
{
return $this->bootstrapServer;
}
/**
* Required. The id of the cluster.
*
* @param string $clusterId
*/
public function setClusterId($clusterId)
{
$this->clusterId = $clusterId;
}
/**
* @return string
*/
public function getClusterId()
{
return $this->clusterId;
}
/**
* Required. The GCP service account to be used for Federated Identity
* authentication with `identity_pool_id`.
*
* @param string $gcpServiceAccount
*/
public function setGcpServiceAccount($gcpServiceAccount)
{
$this->gcpServiceAccount = $gcpServiceAccount;
}
/**
* @return string
*/
public function getGcpServiceAccount()
{
return $this->gcpServiceAccount;
}
/**
* Required. The id of the identity pool to be used for Federated Identity
* authentication with Confluent Cloud. See
* https://docs.confluent.io/cloud/current/security/authenticate/workload-
* identities/identity-providers/oauth/identity-pools.html#add-oauth-identity-
* pools.
*
* @param string $identityPoolId
*/
public function setIdentityPoolId($identityPoolId)
{
$this->identityPoolId = $identityPoolId;
}
/**
* @return string
*/
public function getIdentityPoolId()
{
return $this->identityPoolId;
}
/**
* Output only. An output-only field that indicates the state of the Confluent
* Cloud ingestion source.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE,
* CONFLUENT_CLOUD_PERMISSION_DENIED, PUBLISH_PERMISSION_DENIED,
* UNREACHABLE_BOOTSTRAP_SERVER, CLUSTER_NOT_FOUND, TOPIC_NOT_FOUND,
* CONFLICTING_REGION_CONSTRAINTS
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Required. The name of the topic in the Confluent Cloud cluster that Pub/Sub
* will import from.
*
* @param string $topic
*/
public function setTopic($topic)
{
$this->topic = $topic;
}
/**
* @return string
*/
public function getTopic()
{
return $this->topic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ConfluentCloud::class, 'Google_Service_Pubsub_ConfluentCloud');
vendor/google/apiclient-services/src/Pubsub/CreateSnapshotRequest.php
Vendored
+116
View File
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class CreateSnapshotRequest extends \Google\Model
{
/**
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
* @var string[]
*/
public $labels;
/**
* Required. The subscription whose backlog the snapshot retains.
* Specifically, the created snapshot is guaranteed to retain: (a) The
* existing backlog on the subscription. More precisely, this is defined as
* the messages in the subscription's backlog that are unacknowledged upon the
* successful completion of the `CreateSnapshot` request; as well as: (b) Any
* messages published to the subscription's topic following the successful
* completion of the CreateSnapshot request. Format is
* `projects/{project}/subscriptions/{sub}`.
*
* @var string
*/
public $subscription;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @var string[]
*/
public $tags;
/**
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Required. The subscription whose backlog the snapshot retains.
* Specifically, the created snapshot is guaranteed to retain: (a) The
* existing backlog on the subscription. More precisely, this is defined as
* the messages in the subscription's backlog that are unacknowledged upon the
* successful completion of the `CreateSnapshot` request; as well as: (b) Any
* messages published to the subscription's topic following the successful
* completion of the CreateSnapshot request. Format is
* `projects/{project}/subscriptions/{sub}`.
*
* @param string $subscription
*/
public function setSubscription($subscription)
{
$this->subscription = $subscription;
}
/**
* @return string
*/
public function getSubscription()
{
return $this->subscription;
}
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(CreateSnapshotRequest::class, 'Google_Service_Pubsub_CreateSnapshotRequest');
vendor/google/apiclient-services/src/Pubsub/DeadLetterPolicy.php
Vendored
+96
View File
@@ -0,0 +1,96 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class DeadLetterPolicy extends \Google\Model
{
/**
* Optional. The name of the topic to which dead letter messages should be
* published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub
* service account associated with the enclosing subscription's parent project
* (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
* have permission to Publish() to this topic. The operation will fail if the
* topic does not exist. Users should ensure that there is a subscription
* attached to this topic since messages published to a topic with no
* subscriptions are lost.
*
* @var string
*/
public $deadLetterTopic;
/**
* Optional. The maximum number of delivery attempts for any message. The
* value must be between 5 and 100. The number of delivery attempts is defined
* as 1 + (the sum of number of NACKs and number of times the acknowledgment
* deadline has been exceeded for the message). A NACK is any call to
* ModifyAckDeadline with a 0 deadline. Note that client libraries may
* automatically extend ack_deadlines. This field will be honored on a best
* effort basis. If this parameter is 0, a default value of 5 is used.
*
* @var int
*/
public $maxDeliveryAttempts;
/**
* Optional. The name of the topic to which dead letter messages should be
* published. Format is `projects/{project}/topics/{topic}`.The Pub/Sub
* service account associated with the enclosing subscription's parent project
* (i.e., service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must
* have permission to Publish() to this topic. The operation will fail if the
* topic does not exist. Users should ensure that there is a subscription
* attached to this topic since messages published to a topic with no
* subscriptions are lost.
*
* @param string $deadLetterTopic
*/
public function setDeadLetterTopic($deadLetterTopic)
{
$this->deadLetterTopic = $deadLetterTopic;
}
/**
* @return string
*/
public function getDeadLetterTopic()
{
return $this->deadLetterTopic;
}
/**
* Optional. The maximum number of delivery attempts for any message. The
* value must be between 5 and 100. The number of delivery attempts is defined
* as 1 + (the sum of number of NACKs and number of times the acknowledgment
* deadline has been exceeded for the message). A NACK is any call to
* ModifyAckDeadline with a 0 deadline. Note that client libraries may
* automatically extend ack_deadlines. This field will be honored on a best
* effort basis. If this parameter is 0, a default value of 5 is used.
*
* @param int $maxDeliveryAttempts
*/
public function setMaxDeliveryAttempts($maxDeliveryAttempts)
{
$this->maxDeliveryAttempts = $maxDeliveryAttempts;
}
/**
* @return int
*/
public function getMaxDeliveryAttempts()
{
return $this->maxDeliveryAttempts;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DeadLetterPolicy::class, 'Google_Service_Pubsub_DeadLetterPolicy');
vendor/google/apiclient-services/src/Pubsub/DetachSubscriptionResponse.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class DetachSubscriptionResponse extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(DetachSubscriptionResponse::class, 'Google_Service_Pubsub_DetachSubscriptionResponse');
vendor/google/apiclient-services/src/Pubsub/ExpirationPolicy.php
Vendored
+58
View File
@@ -0,0 +1,58 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ExpirationPolicy extends \Google\Model
{
/**
* Optional. Specifies the "time-to-live" duration for an associated resource.
* The resource expires if it is not active for a period of `ttl`. The
* definition of "activity" depends on the type of the associated resource.
* The minimum and maximum allowed values for `ttl` depend on the type of the
* associated resource, as well. If `ttl` is not set, the associated resource
* never expires.
*
* @var string
*/
public $ttl;
/**
* Optional. Specifies the "time-to-live" duration for an associated resource.
* The resource expires if it is not active for a period of `ttl`. The
* definition of "activity" depends on the type of the associated resource.
* The minimum and maximum allowed values for `ttl` depend on the type of the
* associated resource, as well. If `ttl` is not set, the associated resource
* never expires.
*
* @param string $ttl
*/
public function setTtl($ttl)
{
$this->ttl = $ttl;
}
/**
* @return string
*/
public function getTtl()
{
return $this->ttl;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ExpirationPolicy::class, 'Google_Service_Pubsub_ExpirationPolicy');
vendor/google/apiclient-services/src/Pubsub/Expr.php
Vendored
+122
View File
@@ -0,0 +1,122 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Expr extends \Google\Model
{
/**
* Optional. Description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*
* @var string
*/
public $description;
/**
* Textual representation of an expression in Common Expression Language
* syntax.
*
* @var string
*/
public $expression;
/**
* Optional. String indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*
* @var string
*/
public $location;
/**
* Optional. Title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the expression.
*
* @var string
*/
public $title;
/**
* Optional. Description of the expression. This is a longer text which
* describes the expression, e.g. when hovered over it in a UI.
*
* @param string $description
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Textual representation of an expression in Common Expression Language
* syntax.
*
* @param string $expression
*/
public function setExpression($expression)
{
$this->expression = $expression;
}
/**
* @return string
*/
public function getExpression()
{
return $this->expression;
}
/**
* Optional. String indicating the location of the expression for error
* reporting, e.g. a file name and a position in the file.
*
* @param string $location
*/
public function setLocation($location)
{
$this->location = $location;
}
/**
* @return string
*/
public function getLocation()
{
return $this->location;
}
/**
* Optional. Title for the expression, i.e. a short string describing its
* purpose. This can be used e.g. in UIs which allow to enter the expression.
*
* @param string $title
*/
public function setTitle($title)
{
$this->title = $title;
}
/**
* @return string
*/
public function getTitle()
{
return $this->title;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Expr::class, 'Google_Service_Pubsub_Expr');
vendor/google/apiclient-services/src/Pubsub/IngestionDataSourceSettings.php
Vendored
+135
View File
@@ -0,0 +1,135 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class IngestionDataSourceSettings extends \Google\Model
{
protected $awsKinesisType = AwsKinesis::class;
protected $awsKinesisDataType = '';
protected $awsMskType = AwsMsk::class;
protected $awsMskDataType = '';
protected $azureEventHubsType = AzureEventHubs::class;
protected $azureEventHubsDataType = '';
protected $cloudStorageType = CloudStorage::class;
protected $cloudStorageDataType = '';
protected $confluentCloudType = ConfluentCloud::class;
protected $confluentCloudDataType = '';
protected $platformLogsSettingsType = PlatformLogsSettings::class;
protected $platformLogsSettingsDataType = '';
/**
* Optional. Amazon Kinesis Data Streams.
*
* @param AwsKinesis $awsKinesis
*/
public function setAwsKinesis(AwsKinesis $awsKinesis)
{
$this->awsKinesis = $awsKinesis;
}
/**
* @return AwsKinesis
*/
public function getAwsKinesis()
{
return $this->awsKinesis;
}
/**
* Optional. Amazon MSK.
*
* @param AwsMsk $awsMsk
*/
public function setAwsMsk(AwsMsk $awsMsk)
{
$this->awsMsk = $awsMsk;
}
/**
* @return AwsMsk
*/
public function getAwsMsk()
{
return $this->awsMsk;
}
/**
* Optional. Azure Event Hubs.
*
* @param AzureEventHubs $azureEventHubs
*/
public function setAzureEventHubs(AzureEventHubs $azureEventHubs)
{
$this->azureEventHubs = $azureEventHubs;
}
/**
* @return AzureEventHubs
*/
public function getAzureEventHubs()
{
return $this->azureEventHubs;
}
/**
* Optional. Cloud Storage.
*
* @param CloudStorage $cloudStorage
*/
public function setCloudStorage(CloudStorage $cloudStorage)
{
$this->cloudStorage = $cloudStorage;
}
/**
* @return CloudStorage
*/
public function getCloudStorage()
{
return $this->cloudStorage;
}
/**
* Optional. Confluent Cloud.
*
* @param ConfluentCloud $confluentCloud
*/
public function setConfluentCloud(ConfluentCloud $confluentCloud)
{
$this->confluentCloud = $confluentCloud;
}
/**
* @return ConfluentCloud
*/
public function getConfluentCloud()
{
return $this->confluentCloud;
}
/**
* Optional. Platform Logs settings. If unset, no Platform Logs will be
* generated.
*
* @param PlatformLogsSettings $platformLogsSettings
*/
public function setPlatformLogsSettings(PlatformLogsSettings $platformLogsSettings)
{
$this->platformLogsSettings = $platformLogsSettings;
}
/**
* @return PlatformLogsSettings
*/
public function getPlatformLogsSettings()
{
return $this->platformLogsSettings;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(IngestionDataSourceSettings::class, 'Google_Service_Pubsub_IngestionDataSourceSettings');
vendor/google/apiclient-services/src/Pubsub/JavaScriptUDF.php
Vendored
+92
View File
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class JavaScriptUDF extends \Google\Model
{
/**
* Required. JavaScript code that contains a function `function_name` with the
* below signature: ``` * * Transforms a Pub/Sub message. * @return
* {(Object)>|null)} - To * filter a message, return `null`. To transform a
* message return a map * with the following keys: * - (required) 'data' :
* {string} * - (optional) 'attributes' : {Object} * Returning empty
* `attributes` will remove all attributes from the * message. * * @param
* {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * -
* (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub
* message metadata. * Keys: * - (optional) 'message_id' : {string} * -
* (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * -
* (optional) 'ordering_key': {string} function (message, metadata) { } ```
*
* @var string
*/
public $code;
/**
* Required. Name of the JavasScript function that should applied to Pub/Sub
* messages.
*
* @var string
*/
public $functionName;
/**
* Required. JavaScript code that contains a function `function_name` with the
* below signature: ``` * * Transforms a Pub/Sub message. * @return
* {(Object)>|null)} - To * filter a message, return `null`. To transform a
* message return a map * with the following keys: * - (required) 'data' :
* {string} * - (optional) 'attributes' : {Object} * Returning empty
* `attributes` will remove all attributes from the * message. * * @param
* {(Object)>} Pub/Sub * message. Keys: * - (required) 'data' : {string} * -
* (required) 'attributes' : {Object} * * @param {Object} metadata - Pub/Sub
* message metadata. * Keys: * - (optional) 'message_id' : {string} * -
* (optional) 'publish_time': {string} YYYY-MM-DDTHH:MM:SSZ format * -
* (optional) 'ordering_key': {string} function (message, metadata) { } ```
*
* @param string $code
*/
public function setCode($code)
{
$this->code = $code;
}
/**
* @return string
*/
public function getCode()
{
return $this->code;
}
/**
* Required. Name of the JavasScript function that should applied to Pub/Sub
* messages.
*
* @param string $functionName
*/
public function setFunctionName($functionName)
{
$this->functionName = $functionName;
}
/**
* @return string
*/
public function getFunctionName()
{
return $this->functionName;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(JavaScriptUDF::class, 'Google_Service_Pubsub_JavaScriptUDF');
vendor/google/apiclient-services/src/Pubsub/ListSchemaRevisionsResponse.php
Vendored
+69
View File
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListSchemaRevisionsResponse extends \Google\Collection
{
protected $collection_key = 'schemas';
/**
* A token that can be sent as `page_token` to retrieve the next page. If this
* field is empty, there are no subsequent pages.
*
* @var string
*/
public $nextPageToken;
protected $schemasType = Schema::class;
protected $schemasDataType = 'array';
/**
* A token that can be sent as `page_token` to retrieve the next page. If this
* field is empty, there are no subsequent pages.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* The revisions of the schema.
*
* @param Schema[] $schemas
*/
public function setSchemas($schemas)
{
$this->schemas = $schemas;
}
/**
* @return Schema[]
*/
public function getSchemas()
{
return $this->schemas;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSchemaRevisionsResponse::class, 'Google_Service_Pubsub_ListSchemaRevisionsResponse');
vendor/google/apiclient-services/src/Pubsub/ListSchemasResponse.php
Vendored
+69
View File
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListSchemasResponse extends \Google\Collection
{
protected $collection_key = 'schemas';
/**
* If not empty, indicates that there may be more schemas that match the
* request; this value should be passed in a new `ListSchemasRequest`.
*
* @var string
*/
public $nextPageToken;
protected $schemasType = Schema::class;
protected $schemasDataType = 'array';
/**
* If not empty, indicates that there may be more schemas that match the
* request; this value should be passed in a new `ListSchemasRequest`.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* The resulting schemas.
*
* @param Schema[] $schemas
*/
public function setSchemas($schemas)
{
$this->schemas = $schemas;
}
/**
* @return Schema[]
*/
public function getSchemas()
{
return $this->schemas;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSchemasResponse::class, 'Google_Service_Pubsub_ListSchemasResponse');
vendor/google/apiclient-services/src/Pubsub/ListSnapshotsResponse.php
Vendored
+71
View File
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListSnapshotsResponse extends \Google\Collection
{
protected $collection_key = 'snapshots';
/**
* Optional. If not empty, indicates that there may be more snapshot that
* match the request; this value should be passed in a new
* `ListSnapshotsRequest`.
*
* @var string
*/
public $nextPageToken;
protected $snapshotsType = Snapshot::class;
protected $snapshotsDataType = 'array';
/**
* Optional. If not empty, indicates that there may be more snapshot that
* match the request; this value should be passed in a new
* `ListSnapshotsRequest`.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Optional. The resulting snapshots.
*
* @param Snapshot[] $snapshots
*/
public function setSnapshots($snapshots)
{
$this->snapshots = $snapshots;
}
/**
* @return Snapshot[]
*/
public function getSnapshots()
{
return $this->snapshots;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSnapshotsResponse::class, 'Google_Service_Pubsub_ListSnapshotsResponse');
vendor/google/apiclient-services/src/Pubsub/ListSubscriptionsResponse.php
Vendored
+71
View File
@@ -0,0 +1,71 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListSubscriptionsResponse extends \Google\Collection
{
protected $collection_key = 'subscriptions';
/**
* Optional. If not empty, indicates that there may be more subscriptions that
* match the request; this value should be passed in a new
* `ListSubscriptionsRequest` to get more subscriptions.
*
* @var string
*/
public $nextPageToken;
protected $subscriptionsType = Subscription::class;
protected $subscriptionsDataType = 'array';
/**
* Optional. If not empty, indicates that there may be more subscriptions that
* match the request; this value should be passed in a new
* `ListSubscriptionsRequest` to get more subscriptions.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Optional. The subscriptions that match the request.
*
* @param Subscription[] $subscriptions
*/
public function setSubscriptions($subscriptions)
{
$this->subscriptions = $subscriptions;
}
/**
* @return Subscription[]
*/
public function getSubscriptions()
{
return $this->subscriptions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListSubscriptionsResponse::class, 'Google_Service_Pubsub_ListSubscriptionsResponse');
vendor/google/apiclient-services/src/Pubsub/ListTopicSnapshotsResponse.php
Vendored
+75
View File
@@ -0,0 +1,75 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListTopicSnapshotsResponse extends \Google\Collection
{
protected $collection_key = 'snapshots';
/**
* Optional. If not empty, indicates that there may be more snapshots that
* match the request; this value should be passed in a new
* `ListTopicSnapshotsRequest` to get more snapshots.
*
* @var string
*/
public $nextPageToken;
/**
* Optional. The names of the snapshots that match the request.
*
* @var string[]
*/
public $snapshots;
/**
* Optional. If not empty, indicates that there may be more snapshots that
* match the request; this value should be passed in a new
* `ListTopicSnapshotsRequest` to get more snapshots.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Optional. The names of the snapshots that match the request.
*
* @param string[] $snapshots
*/
public function setSnapshots($snapshots)
{
$this->snapshots = $snapshots;
}
/**
* @return string[]
*/
public function getSnapshots()
{
return $this->snapshots;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListTopicSnapshotsResponse::class, 'Google_Service_Pubsub_ListTopicSnapshotsResponse');
vendor/google/apiclient-services/src/Pubsub/ListTopicSubscriptionsResponse.php
Vendored
+77
View File
@@ -0,0 +1,77 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListTopicSubscriptionsResponse extends \Google\Collection
{
protected $collection_key = 'subscriptions';
/**
* Optional. If not empty, indicates that there may be more subscriptions that
* match the request; this value should be passed in a new
* `ListTopicSubscriptionsRequest` to get more subscriptions.
*
* @var string
*/
public $nextPageToken;
/**
* Optional. The names of subscriptions attached to the topic specified in the
* request.
*
* @var string[]
*/
public $subscriptions;
/**
* Optional. If not empty, indicates that there may be more subscriptions that
* match the request; this value should be passed in a new
* `ListTopicSubscriptionsRequest` to get more subscriptions.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Optional. The names of subscriptions attached to the topic specified in the
* request.
*
* @param string[] $subscriptions
*/
public function setSubscriptions($subscriptions)
{
$this->subscriptions = $subscriptions;
}
/**
* @return string[]
*/
public function getSubscriptions()
{
return $this->subscriptions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListTopicSubscriptionsResponse::class, 'Google_Service_Pubsub_ListTopicSubscriptionsResponse');
vendor/google/apiclient-services/src/Pubsub/ListTopicsResponse.php
Vendored
+69
View File
@@ -0,0 +1,69 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ListTopicsResponse extends \Google\Collection
{
protected $collection_key = 'topics';
/**
* Optional. If not empty, indicates that there may be more topics that match
* the request; this value should be passed in a new `ListTopicsRequest`.
*
* @var string
*/
public $nextPageToken;
protected $topicsType = Topic::class;
protected $topicsDataType = 'array';
/**
* Optional. If not empty, indicates that there may be more topics that match
* the request; this value should be passed in a new `ListTopicsRequest`.
*
* @param string $nextPageToken
*/
public function setNextPageToken($nextPageToken)
{
$this->nextPageToken = $nextPageToken;
}
/**
* @return string
*/
public function getNextPageToken()
{
return $this->nextPageToken;
}
/**
* Optional. The resulting topics.
*
* @param Topic[] $topics
*/
public function setTopics($topics)
{
$this->topics = $topics;
}
/**
* @return Topic[]
*/
public function getTopics()
{
return $this->topics;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ListTopicsResponse::class, 'Google_Service_Pubsub_ListTopicsResponse');
vendor/google/apiclient-services/src/Pubsub/MessageStoragePolicy.php
Vendored
+89
View File
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class MessageStoragePolicy extends \Google\Collection
{
protected $collection_key = 'allowedPersistenceRegions';
/**
* Optional. A list of IDs of Google Cloud regions where messages that are
* published to the topic may be persisted in storage. Messages published by
* publishers running in non-allowed Google Cloud regions (or running outside
* of Google Cloud altogether) are routed for storage in one of the allowed
* regions. An empty list means that no regions are allowed, and is not a
* valid configuration.
*
* @var string[]
*/
public $allowedPersistenceRegions;
/**
* Optional. If true, `allowed_persistence_regions` is also used to enforce
* in-transit guarantees for messages. That is, Pub/Sub will fail Publish
* operations on this topic and subscribe operations on any subscription
* attached to this topic in any region that is not in
* `allowed_persistence_regions`.
*
* @var bool
*/
public $enforceInTransit;
/**
* Optional. A list of IDs of Google Cloud regions where messages that are
* published to the topic may be persisted in storage. Messages published by
* publishers running in non-allowed Google Cloud regions (or running outside
* of Google Cloud altogether) are routed for storage in one of the allowed
* regions. An empty list means that no regions are allowed, and is not a
* valid configuration.
*
* @param string[] $allowedPersistenceRegions
*/
public function setAllowedPersistenceRegions($allowedPersistenceRegions)
{
$this->allowedPersistenceRegions = $allowedPersistenceRegions;
}
/**
* @return string[]
*/
public function getAllowedPersistenceRegions()
{
return $this->allowedPersistenceRegions;
}
/**
* Optional. If true, `allowed_persistence_regions` is also used to enforce
* in-transit guarantees for messages. That is, Pub/Sub will fail Publish
* operations on this topic and subscribe operations on any subscription
* attached to this topic in any region that is not in
* `allowed_persistence_regions`.
*
* @param bool $enforceInTransit
*/
public function setEnforceInTransit($enforceInTransit)
{
$this->enforceInTransit = $enforceInTransit;
}
/**
* @return bool
*/
public function getEnforceInTransit()
{
return $this->enforceInTransit;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessageStoragePolicy::class, 'Google_Service_Pubsub_MessageStoragePolicy');
vendor/google/apiclient-services/src/Pubsub/MessageTransform.php
Vendored
+116
View File
@@ -0,0 +1,116 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class MessageTransform extends \Google\Model
{
protected $aiInferenceType = AIInference::class;
protected $aiInferenceDataType = '';
/**
* Optional. If true, the transform is disabled and will not be applied to
* messages. Defaults to `false`.
*
* @var bool
*/
public $disabled;
/**
* Optional. This field is deprecated, use the `disabled` field to disable
* transforms.
*
* @deprecated
* @var bool
*/
public $enabled;
protected $javascriptUdfType = JavaScriptUDF::class;
protected $javascriptUdfDataType = '';
/**
* Optional. AI Inference. Specifies the Vertex AI endpoint that inference
* requests built from the Pub/Sub message data and provided parameters will
* be sent to.
*
* @param AIInference $aiInference
*/
public function setAiInference(AIInference $aiInference)
{
$this->aiInference = $aiInference;
}
/**
* @return AIInference
*/
public function getAiInference()
{
return $this->aiInference;
}
/**
* Optional. If true, the transform is disabled and will not be applied to
* messages. Defaults to `false`.
*
* @param bool $disabled
*/
public function setDisabled($disabled)
{
$this->disabled = $disabled;
}
/**
* @return bool
*/
public function getDisabled()
{
return $this->disabled;
}
/**
* Optional. This field is deprecated, use the `disabled` field to disable
* transforms.
*
* @deprecated
* @param bool $enabled
*/
public function setEnabled($enabled)
{
$this->enabled = $enabled;
}
/**
* @deprecated
* @return bool
*/
public function getEnabled()
{
return $this->enabled;
}
/**
* Optional. JavaScript User Defined Function. If multiple JavaScriptUDF's are
* specified on a resource, each must have a unique `function_name`.
*
* @param JavaScriptUDF $javascriptUdf
*/
public function setJavascriptUdf(JavaScriptUDF $javascriptUdf)
{
$this->javascriptUdf = $javascriptUdf;
}
/**
* @return JavaScriptUDF
*/
public function getJavascriptUdf()
{
return $this->javascriptUdf;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(MessageTransform::class, 'Google_Service_Pubsub_MessageTransform');
vendor/google/apiclient-services/src/Pubsub/ModifyAckDeadlineRequest.php
Vendored
+85
View File
@@ -0,0 +1,85 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ModifyAckDeadlineRequest extends \Google\Collection
{
protected $collection_key = 'ackIds';
/**
* Required. The new ack deadline with respect to the time this request was
* sent to the Pub/Sub system. For example, if the value is 10, the new ack
* deadline will expire 10 seconds after the `ModifyAckDeadline` call was
* made. Specifying zero might immediately make the message available for
* delivery to another subscriber client. This typically results in an
* increase in the rate of message redeliveries (that is, duplicates). The
* minimum deadline you can specify is 0 seconds. The maximum deadline you can
* specify in a single request is 600 seconds (10 minutes).
*
* @var int
*/
public $ackDeadlineSeconds;
/**
* Required. List of acknowledgment IDs.
*
* @var string[]
*/
public $ackIds;
/**
* Required. The new ack deadline with respect to the time this request was
* sent to the Pub/Sub system. For example, if the value is 10, the new ack
* deadline will expire 10 seconds after the `ModifyAckDeadline` call was
* made. Specifying zero might immediately make the message available for
* delivery to another subscriber client. This typically results in an
* increase in the rate of message redeliveries (that is, duplicates). The
* minimum deadline you can specify is 0 seconds. The maximum deadline you can
* specify in a single request is 600 seconds (10 minutes).
*
* @param int $ackDeadlineSeconds
*/
public function setAckDeadlineSeconds($ackDeadlineSeconds)
{
$this->ackDeadlineSeconds = $ackDeadlineSeconds;
}
/**
* @return int
*/
public function getAckDeadlineSeconds()
{
return $this->ackDeadlineSeconds;
}
/**
* Required. List of acknowledgment IDs.
*
* @param string[] $ackIds
*/
public function setAckIds($ackIds)
{
$this->ackIds = $ackIds;
}
/**
* @return string[]
*/
public function getAckIds()
{
return $this->ackIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ModifyAckDeadlineRequest::class, 'Google_Service_Pubsub_ModifyAckDeadlineRequest');
vendor/google/apiclient-services/src/Pubsub/ModifyPushConfigRequest.php
Vendored
+48
View File
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ModifyPushConfigRequest extends \Google\Model
{
protected $pushConfigType = PushConfig::class;
protected $pushConfigDataType = '';
/**
* Required. The push configuration for future deliveries. An empty
* `pushConfig` indicates that the Pub/Sub system should stop pushing messages
* from the given subscription and allow messages to be pulled and
* acknowledged - effectively pausing the subscription if `Pull` or
* `StreamingPull` is not called.
*
* @param PushConfig $pushConfig
*/
public function setPushConfig(PushConfig $pushConfig)
{
$this->pushConfig = $pushConfig;
}
/**
* @return PushConfig
*/
public function getPushConfig()
{
return $this->pushConfig;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ModifyPushConfigRequest::class, 'Google_Service_Pubsub_ModifyPushConfigRequest');
vendor/google/apiclient-services/src/Pubsub/NoWrapper.php
Vendored
+52
View File
@@ -0,0 +1,52 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class NoWrapper extends \Google\Model
{
/**
* Optional. When true, writes the Pub/Sub message metadata to `x-goog-
* pubsub-:` headers of the HTTP request. Writes the Pub/Sub message
* attributes to `:` headers of the HTTP request.
*
* @var bool
*/
public $writeMetadata;
/**
* Optional. When true, writes the Pub/Sub message metadata to `x-goog-
* pubsub-:` headers of the HTTP request. Writes the Pub/Sub message
* attributes to `:` headers of the HTTP request.
*
* @param bool $writeMetadata
*/
public function setWriteMetadata($writeMetadata)
{
$this->writeMetadata = $writeMetadata;
}
/**
* @return bool
*/
public function getWriteMetadata()
{
return $this->writeMetadata;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(NoWrapper::class, 'Google_Service_Pubsub_NoWrapper');
vendor/google/apiclient-services/src/Pubsub/OidcToken.php
Vendored
+88
View File
@@ -0,0 +1,88 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class OidcToken extends \Google\Model
{
/**
* Optional. Audience to be used when generating OIDC token. The audience
* claim identifies the recipients that the JWT is intended for. The audience
* value is a single case-sensitive string. Having multiple values (array) for
* the audience field is not supported. More info about the OIDC JWT token
* audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if
* not specified, the Push endpoint URL will be used.
*
* @var string
*/
public $audience;
/**
* Optional. [Service account
* email](https://cloud.google.com/iam/docs/service-accounts) used for
* generating the OIDC token. For more information on setting up
* authentication, see [Push
* subscriptions](https://cloud.google.com/pubsub/docs/push).
*
* @var string
*/
public $serviceAccountEmail;
/**
* Optional. Audience to be used when generating OIDC token. The audience
* claim identifies the recipients that the JWT is intended for. The audience
* value is a single case-sensitive string. Having multiple values (array) for
* the audience field is not supported. More info about the OIDC JWT token
* audience here: https://tools.ietf.org/html/rfc7519#section-4.1.3 Note: if
* not specified, the Push endpoint URL will be used.
*
* @param string $audience
*/
public function setAudience($audience)
{
$this->audience = $audience;
}
/**
* @return string
*/
public function getAudience()
{
return $this->audience;
}
/**
* Optional. [Service account
* email](https://cloud.google.com/iam/docs/service-accounts) used for
* generating the OIDC token. For more information on setting up
* authentication, see [Push
* subscriptions](https://cloud.google.com/pubsub/docs/push).
*
* @param string $serviceAccountEmail
*/
public function setServiceAccountEmail($serviceAccountEmail)
{
$this->serviceAccountEmail = $serviceAccountEmail;
}
/**
* @return string
*/
public function getServiceAccountEmail()
{
return $this->serviceAccountEmail;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(OidcToken::class, 'Google_Service_Pubsub_OidcToken');
vendor/google/apiclient-services/src/Pubsub/PlatformLogsSettings.php
Vendored
+75
View File
@@ -0,0 +1,75 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PlatformLogsSettings extends \Google\Model
{
/**
* Default value. Logs level is unspecified. Logs will be disabled.
*/
public const SEVERITY_SEVERITY_UNSPECIFIED = 'SEVERITY_UNSPECIFIED';
/**
* Logs will be disabled.
*/
public const SEVERITY_DISABLED = 'DISABLED';
/**
* Debug logs and higher-severity logs will be written.
*/
public const SEVERITY_DEBUG = 'DEBUG';
/**
* Info logs and higher-severity logs will be written.
*/
public const SEVERITY_INFO = 'INFO';
/**
* Warning logs and higher-severity logs will be written.
*/
public const SEVERITY_WARNING = 'WARNING';
/**
* Only error logs will be written.
*/
public const SEVERITY_ERROR = 'ERROR';
/**
* Optional. The minimum severity level of Platform Logs that will be written.
*
* @var string
*/
public $severity;
/**
* Optional. The minimum severity level of Platform Logs that will be written.
*
* Accepted values: SEVERITY_UNSPECIFIED, DISABLED, DEBUG, INFO, WARNING,
* ERROR
*
* @param self::SEVERITY_* $severity
*/
public function setSeverity($severity)
{
$this->severity = $severity;
}
/**
* @return self::SEVERITY_*
*/
public function getSeverity()
{
return $this->severity;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PlatformLogsSettings::class, 'Google_Service_Pubsub_PlatformLogsSettings');
vendor/google/apiclient-services/src/Pubsub/Policy.php
Vendored
+147
View File
@@ -0,0 +1,147 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Policy extends \Google\Collection
{
protected $collection_key = 'bindings';
protected $bindingsType = Binding::class;
protected $bindingsDataType = 'array';
/**
* `etag` is used for optimistic concurrency control as a way to help prevent
* simultaneous updates of a policy from overwriting each other. It is
* strongly suggested that systems make use of the `etag` in the read-modify-
* write cycle to perform policy updates in order to avoid race conditions: An
* `etag` is returned in the response to `getIamPolicy`, and systems are
* expected to put that etag in the request to `setIamPolicy` to ensure that
* their change will be applied to the same version of the policy.
* **Important:** If you use IAM Conditions, you must include the `etag` field
* whenever you call `setIamPolicy`. If you omit this field, then IAM allows
* you to overwrite a version `3` policy with a version `1` policy, and all of
* the conditions in the version `3` policy are lost.
*
* @var string
*/
public $etag;
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
* Requests that specify an invalid value are rejected. Any operation that
* affects conditional role bindings must specify version `3`. This
* requirement applies to the following operations: * Getting a policy that
* includes a conditional role binding * Adding a conditional role binding to
* a policy * Changing a conditional role binding in a policy * Removing any
* role binding, with or without a condition, from a policy that includes
* conditions **Important:** If you use IAM Conditions, you must include the
* `etag` field whenever you call `setIamPolicy`. If you omit this field, then
* IAM allows you to overwrite a version `3` policy with a version `1` policy,
* and all of the conditions in the version `3` policy are lost. If a policy
* does not include any conditions, operations on that policy may specify any
* valid version or leave the field unset. To learn which resources support
* conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @var int
*/
public $version;
/**
* Associates a list of `members`, or principals, with a `role`. Optionally,
* may specify a `condition` that determines how and when the `bindings` are
* applied. Each of the `bindings` must contain at least one principal. The
* `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of
* these principals can be Google groups. Each occurrence of a principal
* counts towards these limits. For example, if the `bindings` grant 50
* different roles to `user:alice@example.com`, and not to any other
* principal, then you can add another 1,450 principals to the `bindings` in
* the `Policy`.
*
* @param Binding[] $bindings
*/
public function setBindings($bindings)
{
$this->bindings = $bindings;
}
/**
* @return Binding[]
*/
public function getBindings()
{
return $this->bindings;
}
/**
* `etag` is used for optimistic concurrency control as a way to help prevent
* simultaneous updates of a policy from overwriting each other. It is
* strongly suggested that systems make use of the `etag` in the read-modify-
* write cycle to perform policy updates in order to avoid race conditions: An
* `etag` is returned in the response to `getIamPolicy`, and systems are
* expected to put that etag in the request to `setIamPolicy` to ensure that
* their change will be applied to the same version of the policy.
* **Important:** If you use IAM Conditions, you must include the `etag` field
* whenever you call `setIamPolicy`. If you omit this field, then IAM allows
* you to overwrite a version `3` policy with a version `1` policy, and all of
* the conditions in the version `3` policy are lost.
*
* @param string $etag
*/
public function setEtag($etag)
{
$this->etag = $etag;
}
/**
* @return string
*/
public function getEtag()
{
return $this->etag;
}
/**
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
* Requests that specify an invalid value are rejected. Any operation that
* affects conditional role bindings must specify version `3`. This
* requirement applies to the following operations: * Getting a policy that
* includes a conditional role binding * Adding a conditional role binding to
* a policy * Changing a conditional role binding in a policy * Removing any
* role binding, with or without a condition, from a policy that includes
* conditions **Important:** If you use IAM Conditions, you must include the
* `etag` field whenever you call `setIamPolicy`. If you omit this field, then
* IAM allows you to overwrite a version `3` policy with a version `1` policy,
* and all of the conditions in the version `3` policy are lost. If a policy
* does not include any conditions, operations on that policy may specify any
* valid version or leave the field unset. To learn which resources support
* conditions in their IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
*
* @param int $version
*/
public function setVersion($version)
{
$this->version = $version;
}
/**
* @return int
*/
public function getVersion()
{
return $this->version;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Policy::class, 'Google_Service_Pubsub_Policy');
vendor/google/apiclient-services/src/Pubsub/PubSubAvroFormat.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PubSubAvroFormat extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PubSubAvroFormat::class, 'Google_Service_Pubsub_PubSubAvroFormat');
vendor/google/apiclient-services/src/Pubsub/PublishRequest.php
Vendored
+45
View File
@@ -0,0 +1,45 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PublishRequest extends \Google\Collection
{
protected $collection_key = 'messages';
protected $messagesType = PubsubMessage::class;
protected $messagesDataType = 'array';
/**
* Required. The messages to publish.
*
* @param PubsubMessage[] $messages
*/
public function setMessages($messages)
{
$this->messages = $messages;
}
/**
* @return PubsubMessage[]
*/
public function getMessages()
{
return $this->messages;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PublishRequest::class, 'Google_Service_Pubsub_PublishRequest');
vendor/google/apiclient-services/src/Pubsub/PublishResponse.php
Vendored
+53
View File
@@ -0,0 +1,53 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PublishResponse extends \Google\Collection
{
protected $collection_key = 'messageIds';
/**
* Optional. The server-assigned ID of each published message, in the same
* order as the messages in the request. IDs are guaranteed to be unique
* within the topic.
*
* @var string[]
*/
public $messageIds;
/**
* Optional. The server-assigned ID of each published message, in the same
* order as the messages in the request. IDs are guaranteed to be unique
* within the topic.
*
* @param string[] $messageIds
*/
public function setMessageIds($messageIds)
{
$this->messageIds = $messageIds;
}
/**
* @return string[]
*/
public function getMessageIds()
{
return $this->messageIds;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PublishResponse::class, 'Google_Service_Pubsub_PublishResponse');
vendor/google/apiclient-services/src/Pubsub/PubsubEmpty.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PubsubEmpty extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PubsubEmpty::class, 'Google_Service_Pubsub_PubsubEmpty');
vendor/google/apiclient-services/src/Pubsub/PubsubMessage.php
Vendored
+166
View File
@@ -0,0 +1,166 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PubsubMessage extends \Google\Model
{
/**
* Optional. Attributes for this message. If this field is empty, the message
* must contain non-empty data. This can be used to filter messages on the
* subscription.
*
* @var string[]
*/
public $attributes;
/**
* Optional. The message data field. If this field is empty, the message must
* contain at least one attribute.
*
* @var string
*/
public $data;
/**
* ID of this message, assigned by the server when the message is published.
* Guaranteed to be unique within the topic. This value may be read by a
* subscriber that receives a `PubsubMessage` via a `Pull` call or a push
* delivery. It must not be populated by the publisher in a `Publish` call.
*
* @var string
*/
public $messageId;
/**
* Optional. If non-empty, identifies related messages for which publish order
* should be respected. If a `Subscription` has `enable_message_ordering` set
* to `true`, messages published with the same non-empty `ordering_key` value
* will be delivered to subscribers in the order in which they are received by
* the Pub/Sub system. All `PubsubMessage`s published in a given
* `PublishRequest` must specify the same `ordering_key` value. For more
* information, see [ordering
* messages](https://cloud.google.com/pubsub/docs/ordering).
*
* @var string
*/
public $orderingKey;
/**
* The time at which the message was published, populated by the server when
* it receives the `Publish` call. It must not be populated by the publisher
* in a `Publish` call.
*
* @var string
*/
public $publishTime;
/**
* Optional. Attributes for this message. If this field is empty, the message
* must contain non-empty data. This can be used to filter messages on the
* subscription.
*
* @param string[] $attributes
*/
public function setAttributes($attributes)
{
$this->attributes = $attributes;
}
/**
* @return string[]
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Optional. The message data field. If this field is empty, the message must
* contain at least one attribute.
*
* @param string $data
*/
public function setData($data)
{
$this->data = $data;
}
/**
* @return string
*/
public function getData()
{
return $this->data;
}
/**
* ID of this message, assigned by the server when the message is published.
* Guaranteed to be unique within the topic. This value may be read by a
* subscriber that receives a `PubsubMessage` via a `Pull` call or a push
* delivery. It must not be populated by the publisher in a `Publish` call.
*
* @param string $messageId
*/
public function setMessageId($messageId)
{
$this->messageId = $messageId;
}
/**
* @return string
*/
public function getMessageId()
{
return $this->messageId;
}
/**
* Optional. If non-empty, identifies related messages for which publish order
* should be respected. If a `Subscription` has `enable_message_ordering` set
* to `true`, messages published with the same non-empty `ordering_key` value
* will be delivered to subscribers in the order in which they are received by
* the Pub/Sub system. All `PubsubMessage`s published in a given
* `PublishRequest` must specify the same `ordering_key` value. For more
* information, see [ordering
* messages](https://cloud.google.com/pubsub/docs/ordering).
*
* @param string $orderingKey
*/
public function setOrderingKey($orderingKey)
{
$this->orderingKey = $orderingKey;
}
/**
* @return string
*/
public function getOrderingKey()
{
return $this->orderingKey;
}
/**
* The time at which the message was published, populated by the server when
* it receives the `Publish` call. It must not be populated by the publisher
* in a `Publish` call.
*
* @param string $publishTime
*/
public function setPublishTime($publishTime)
{
$this->publishTime = $publishTime;
}
/**
* @return string
*/
public function getPublishTime()
{
return $this->publishTime;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PubsubMessage::class, 'Google_Service_Pubsub_PubsubMessage');
vendor/google/apiclient-services/src/Pubsub/PubsubWrapper.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PubsubWrapper extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PubsubWrapper::class, 'Google_Service_Pubsub_PubsubWrapper');
vendor/google/apiclient-services/src/Pubsub/PullRequest.php
Vendored
+89
View File
@@ -0,0 +1,89 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PullRequest extends \Google\Model
{
/**
* Required. The maximum number of messages to return for this request. Must
* be a positive integer. The Pub/Sub system may return fewer than the number
* specified.
*
* @var int
*/
public $maxMessages;
/**
* Optional. If this field set to true, the system will respond immediately
* even if it there are no messages available to return in the `Pull`
* response. Otherwise, the system may wait (for a bounded amount of time)
* until at least one message is available, rather than returning no messages.
* Warning: setting this field to `true` is discouraged because it adversely
* impacts the performance of `Pull` operations. We recommend that users do
* not set this field.
*
* @deprecated
* @var bool
*/
public $returnImmediately;
/**
* Required. The maximum number of messages to return for this request. Must
* be a positive integer. The Pub/Sub system may return fewer than the number
* specified.
*
* @param int $maxMessages
*/
public function setMaxMessages($maxMessages)
{
$this->maxMessages = $maxMessages;
}
/**
* @return int
*/
public function getMaxMessages()
{
return $this->maxMessages;
}
/**
* Optional. If this field set to true, the system will respond immediately
* even if it there are no messages available to return in the `Pull`
* response. Otherwise, the system may wait (for a bounded amount of time)
* until at least one message is available, rather than returning no messages.
* Warning: setting this field to `true` is discouraged because it adversely
* impacts the performance of `Pull` operations. We recommend that users do
* not set this field.
*
* @deprecated
* @param bool $returnImmediately
*/
public function setReturnImmediately($returnImmediately)
{
$this->returnImmediately = $returnImmediately;
}
/**
* @deprecated
* @return bool
*/
public function getReturnImmediately()
{
return $this->returnImmediately;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PullRequest::class, 'Google_Service_Pubsub_PullRequest');
vendor/google/apiclient-services/src/Pubsub/PullResponse.php
Vendored
+49
View File
@@ -0,0 +1,49 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PullResponse extends \Google\Collection
{
protected $collection_key = 'receivedMessages';
protected $receivedMessagesType = ReceivedMessage::class;
protected $receivedMessagesDataType = 'array';
/**
* Optional. Received Pub/Sub messages. The list will be empty if there are no
* more messages available in the backlog, or if no messages could be returned
* before the request timeout. For JSON, the response can be entirely empty.
* The Pub/Sub system may return fewer than the `maxMessages` requested even
* if there are more messages available in the backlog.
*
* @param ReceivedMessage[] $receivedMessages
*/
public function setReceivedMessages($receivedMessages)
{
$this->receivedMessages = $receivedMessages;
}
/**
* @return ReceivedMessage[]
*/
public function getReceivedMessages()
{
return $this->receivedMessages;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PullResponse::class, 'Google_Service_Pubsub_PullResponse');
vendor/google/apiclient-services/src/Pubsub/PushConfig.php
Vendored
+155
View File
@@ -0,0 +1,155 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class PushConfig extends \Google\Model
{
/**
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery. The only currently supported
* attribute is `x-goog-version`, which you can use to change the format of
* the pushed message. This attribute indicates the version of the data
* expected by the endpoint. This controls the shape of the pushed message
* (i.e., its fields and metadata). If not present during the
* `CreateSubscription` call, it will default to the version of the Pub/Sub
* API used to make such call. If not present in a `ModifyPushConfig` call,
* its value will not be changed. `GetSubscription` calls will always return a
* valid version, even if the subscription was created without this attribute.
* The only supported values for the `x-goog-version` attribute are: *
* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1`
* or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For
* example: `attributes { "x-goog-version": "v1" }`
*
* @var string[]
*/
public $attributes;
protected $noWrapperType = NoWrapper::class;
protected $noWrapperDataType = '';
protected $oidcTokenType = OidcToken::class;
protected $oidcTokenDataType = '';
protected $pubsubWrapperType = PubsubWrapper::class;
protected $pubsubWrapperDataType = '';
/**
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
*
* @var string
*/
public $pushEndpoint;
/**
* Optional. Endpoint configuration attributes that can be used to control
* different aspects of the message delivery. The only currently supported
* attribute is `x-goog-version`, which you can use to change the format of
* the pushed message. This attribute indicates the version of the data
* expected by the endpoint. This controls the shape of the pushed message
* (i.e., its fields and metadata). If not present during the
* `CreateSubscription` call, it will default to the version of the Pub/Sub
* API used to make such call. If not present in a `ModifyPushConfig` call,
* its value will not be changed. `GetSubscription` calls will always return a
* valid version, even if the subscription was created without this attribute.
* The only supported values for the `x-goog-version` attribute are: *
* `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API. * `v1`
* or `v1beta2`: uses the push format defined in the v1 Pub/Sub API. For
* example: `attributes { "x-goog-version": "v1" }`
*
* @param string[] $attributes
*/
public function setAttributes($attributes)
{
$this->attributes = $attributes;
}
/**
* @return string[]
*/
public function getAttributes()
{
return $this->attributes;
}
/**
* Optional. When set, the payload to the push endpoint is not wrapped.
*
* @param NoWrapper $noWrapper
*/
public function setNoWrapper(NoWrapper $noWrapper)
{
$this->noWrapper = $noWrapper;
}
/**
* @return NoWrapper
*/
public function getNoWrapper()
{
return $this->noWrapper;
}
/**
* Optional. If specified, Pub/Sub will generate and attach an OIDC JWT token
* as an `Authorization` header in the HTTP request for every pushed message.
*
* @param OidcToken $oidcToken
*/
public function setOidcToken(OidcToken $oidcToken)
{
$this->oidcToken = $oidcToken;
}
/**
* @return OidcToken
*/
public function getOidcToken()
{
return $this->oidcToken;
}
/**
* Optional. When set, the payload to the push endpoint is in the form of the
* JSON representation of a PubsubMessage (https://cloud.google.com/pubsub/doc
* s/reference/rpc/google.pubsub.v1#pubsubmessage).
*
* @param PubsubWrapper $pubsubWrapper
*/
public function setPubsubWrapper(PubsubWrapper $pubsubWrapper)
{
$this->pubsubWrapper = $pubsubWrapper;
}
/**
* @return PubsubWrapper
*/
public function getPubsubWrapper()
{
return $this->pubsubWrapper;
}
/**
* Optional. A URL locating the endpoint to which messages should be pushed.
* For example, a Webhook endpoint might use `https://example.com/push`.
*
* @param string $pushEndpoint
*/
public function setPushEndpoint($pushEndpoint)
{
$this->pushEndpoint = $pushEndpoint;
}
/**
* @return string
*/
public function getPushEndpoint()
{
return $this->pushEndpoint;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(PushConfig::class, 'Google_Service_Pubsub_PushConfig');
vendor/google/apiclient-services/src/Pubsub/ReceivedMessage.php
Vendored
+108
View File
@@ -0,0 +1,108 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ReceivedMessage extends \Google\Model
{
/**
* Optional. This ID can be used to acknowledge the received message.
*
* @var string
*/
public $ackId;
/**
* Optional. The approximate number of times that Pub/Sub has attempted to
* deliver the associated message to a subscriber. More precisely, this is 1 +
* (number of NACKs) + (number of ack_deadline exceeds) for this message. A
* NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
* exceeds event is whenever a message is not acknowledged within
* ack_deadline. Note that ack_deadline is initially
* Subscription.ackDeadlineSeconds, but may get extended automatically by the
* client library. Upon the first delivery of a given message,
* `delivery_attempt` will have a value of 1. The value is calculated at best
* effort and is approximate. If a DeadLetterPolicy is not set on the
* subscription, this will be 0.
*
* @var int
*/
public $deliveryAttempt;
protected $messageType = PubsubMessage::class;
protected $messageDataType = '';
/**
* Optional. This ID can be used to acknowledge the received message.
*
* @param string $ackId
*/
public function setAckId($ackId)
{
$this->ackId = $ackId;
}
/**
* @return string
*/
public function getAckId()
{
return $this->ackId;
}
/**
* Optional. The approximate number of times that Pub/Sub has attempted to
* deliver the associated message to a subscriber. More precisely, this is 1 +
* (number of NACKs) + (number of ack_deadline exceeds) for this message. A
* NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
* exceeds event is whenever a message is not acknowledged within
* ack_deadline. Note that ack_deadline is initially
* Subscription.ackDeadlineSeconds, but may get extended automatically by the
* client library. Upon the first delivery of a given message,
* `delivery_attempt` will have a value of 1. The value is calculated at best
* effort and is approximate. If a DeadLetterPolicy is not set on the
* subscription, this will be 0.
*
* @param int $deliveryAttempt
*/
public function setDeliveryAttempt($deliveryAttempt)
{
$this->deliveryAttempt = $deliveryAttempt;
}
/**
* @return int
*/
public function getDeliveryAttempt()
{
return $this->deliveryAttempt;
}
/**
* Optional. The message.
*
* @param PubsubMessage $message
*/
public function setMessage(PubsubMessage $message)
{
$this->message = $message;
}
/**
* @return PubsubMessage
*/
public function getMessage()
{
return $this->message;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ReceivedMessage::class, 'Google_Service_Pubsub_ReceivedMessage');
vendor/google/apiclient-services/src/Pubsub/Resource/Projects.php
Vendored
+33
View File
@@ -0,0 +1,33 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
/**
* The "projects" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $projects = $pubsubService->projects;
* </code>
*/
class Projects extends \Google\Service\Resource
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Projects::class, 'Google_Service_Pubsub_Resource_Projects');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsSchemas.php
Vendored
+304
View File
@@ -0,0 +1,304 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\CommitSchemaRequest;
use Google\Service\Pubsub\ListSchemaRevisionsResponse;
use Google\Service\Pubsub\ListSchemasResponse;
use Google\Service\Pubsub\Policy;
use Google\Service\Pubsub\PubsubEmpty;
use Google\Service\Pubsub\RollbackSchemaRequest;
use Google\Service\Pubsub\Schema;
use Google\Service\Pubsub\SetIamPolicyRequest;
use Google\Service\Pubsub\TestIamPermissionsRequest;
use Google\Service\Pubsub\TestIamPermissionsResponse;
use Google\Service\Pubsub\ValidateMessageRequest;
use Google\Service\Pubsub\ValidateMessageResponse;
use Google\Service\Pubsub\ValidateSchemaRequest;
use Google\Service\Pubsub\ValidateSchemaResponse;
/**
* The "schemas" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $schemas = $pubsubService->projects_schemas;
* </code>
*/
class ProjectsSchemas extends \Google\Service\Resource
{
/**
* Commits a new schema revision to an existing schema. (schemas.commit)
*
* @param string $name Required. The name of the schema we are revising. Format
* is `projects/{project}/schemas/{schema}`.
* @param CommitSchemaRequest $postBody
* @param array $optParams Optional parameters.
* @return Schema
* @throws \Google\Service\Exception
*/
public function commit($name, CommitSchemaRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('commit', [$params], Schema::class);
}
/**
* Creates a schema. (schemas.create)
*
* @param string $parent Required. The name of the project in which to create
* the schema. Format is `projects/{project-id}`.
* @param Schema $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string schemaId The ID to use for the schema, which will become
* the final component of the schema's resource name. See
* https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names for
* resource name constraints.
* @return Schema
* @throws \Google\Service\Exception
*/
public function create($parent, Schema $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Schema::class);
}
/**
* Deletes a schema. (schemas.delete)
*
* @param string $name Required. Name of the schema to delete. Format is
* `projects/{project}/schemas/{schema}`.
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function delete($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], PubsubEmpty::class);
}
/**
* Deletes a specific schema revision. (schemas.deleteRevision)
*
* @param string $name Required. The name of the schema revision to be deleted,
* with a revision ID explicitly included. Example: `projects/123/schemas/my-
* schema@c7cfa2a8`
* @param array $optParams Optional parameters.
*
* @opt_param string revisionId Optional. This field is deprecated and should
* not be used for specifying the revision ID. The revision ID should be
* specified via the `name` parameter.
* @return Schema
* @throws \Google\Service\Exception
*/
public function deleteRevision($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('deleteRevision', [$params], Schema::class);
}
/**
* Gets a schema. (schemas.get)
*
* @param string $name Required. The name of the schema to get. Format is
* `projects/{project}/schemas/{schema}`.
* @param array $optParams Optional parameters.
*
* @opt_param string view The set of fields to return in the response. If not
* set, returns a Schema with all fields filled out. Set to `BASIC` to omit the
* `definition`.
* @return Schema
* @throws \Google\Service\Exception
*/
public function get($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Schema::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (schemas.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists schemas in a project. (schemas.listProjectsSchemas)
*
* @param string $parent Required. The name of the project in which to list
* schemas. Format is `projects/{project-id}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Maximum number of schemas to return.
* @opt_param string pageToken The value returned by the last
* `ListSchemasResponse`; indicates that this is a continuation of a prior
* `ListSchemas` call, and that the system should return the next page of data.
* @opt_param string view The set of Schema fields to return in the response. If
* not set, returns Schemas with `name` and `type`, but not `definition`. Set to
* `FULL` to retrieve all fields.
* @return ListSchemasResponse
* @throws \Google\Service\Exception
*/
public function listProjectsSchemas($parent, $optParams = [])
{
$params = ['parent' => $parent];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSchemasResponse::class);
}
/**
* Lists all schema revisions for the named schema. (schemas.listRevisions)
*
* @param string $name Required. The name of the schema to list revisions for.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize The maximum number of revisions to return per page.
* @opt_param string pageToken The page token, received from a previous
* ListSchemaRevisions call. Provide this to retrieve the subsequent page.
* @opt_param string view The set of Schema fields to return in the response. If
* not set, returns Schemas with `name` and `type`, but not `definition`. Set to
* `FULL` to retrieve all fields.
* @return ListSchemaRevisionsResponse
* @throws \Google\Service\Exception
*/
public function listRevisions($name, $optParams = [])
{
$params = ['name' => $name];
$params = array_merge($params, $optParams);
return $this->call('listRevisions', [$params], ListSchemaRevisionsResponse::class);
}
/**
* Creates a new schema revision that is a copy of the provided revision_id.
* (schemas.rollback)
*
* @param string $name Required. The schema being rolled back with revision id.
* @param RollbackSchemaRequest $postBody
* @param array $optParams Optional parameters.
* @return Schema
* @throws \Google\Service\Exception
*/
public function rollback($name, RollbackSchemaRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('rollback', [$params], Schema::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (schemas.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning. (schemas.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
/**
* Validates a schema. (schemas.validate)
*
* @param string $parent Required. The name of the project in which to validate
* schemas. Format is `projects/{project-id}`.
* @param ValidateSchemaRequest $postBody
* @param array $optParams Optional parameters.
* @return ValidateSchemaResponse
* @throws \Google\Service\Exception
*/
public function validate($parent, ValidateSchemaRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('validate', [$params], ValidateSchemaResponse::class);
}
/**
* Validates a message against a schema. (schemas.validateMessage)
*
* @param string $parent Required. The name of the project in which to validate
* schemas. Format is `projects/{project-id}`.
* @param ValidateMessageRequest $postBody
* @param array $optParams Optional parameters.
* @return ValidateMessageResponse
* @throws \Google\Service\Exception
*/
public function validateMessage($parent, ValidateMessageRequest $postBody, $optParams = [])
{
$params = ['parent' => $parent, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('validateMessage', [$params], ValidateMessageResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsSchemas::class, 'Google_Service_Pubsub_Resource_ProjectsSchemas');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsSnapshots.php
Vendored
+238
View File
@@ -0,0 +1,238 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\CreateSnapshotRequest;
use Google\Service\Pubsub\ListSnapshotsResponse;
use Google\Service\Pubsub\Policy;
use Google\Service\Pubsub\PubsubEmpty;
use Google\Service\Pubsub\SetIamPolicyRequest;
use Google\Service\Pubsub\Snapshot;
use Google\Service\Pubsub\TestIamPermissionsRequest;
use Google\Service\Pubsub\TestIamPermissionsResponse;
use Google\Service\Pubsub\UpdateSnapshotRequest;
/**
* The "snapshots" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $snapshots = $pubsubService->projects_snapshots;
* </code>
*/
class ProjectsSnapshots extends \Google\Service\Resource
{
/**
* Creates a snapshot from the requested subscription. Snapshots are used in
* [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
* which allow you to manage message acknowledgments in bulk. That is, you can
* set the acknowledgment state of messages in an existing subscription to the
* state captured by a snapshot. If the snapshot already exists, returns
* `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns
* `NOT_FOUND`. If the backlog in the subscription is too old -- and the
* resulting snapshot would expire in less than 1 hour -- then
* `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field.
* If the name is not provided in the request, the server will assign a random
* name for this snapshot on the same project as the subscription, conforming to
* the [resource name format] (https://cloud.google.com/pubsub/docs/pubsub-
* basics#resource_names). The generated name is populated in the returned
* Snapshot object. Note that for REST API requests, you must specify a name in
* the request. (snapshots.create)
*
* @param string $name Required. User-provided name for this snapshot. If the
* name is not provided in the request, the server will assign a random name for
* this snapshot on the same project as the subscription. Note that for REST API
* requests, you must specify a name. See the [resource name
* rules](https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* Format is `projects/{project}/snapshots/{snap}`.
* @param CreateSnapshotRequest $postBody
* @param array $optParams Optional parameters.
* @return Snapshot
* @throws \Google\Service\Exception
*/
public function create($name, CreateSnapshotRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Snapshot::class);
}
/**
* Removes an existing snapshot. Snapshots are used in [Seek]
* (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
* allow you to manage message acknowledgments in bulk. That is, you can set the
* acknowledgment state of messages in an existing subscription to the state
* captured by a snapshot. When the snapshot is deleted, all messages retained
* in the snapshot are immediately dropped. After a snapshot is deleted, a new
* one may be created with the same name, but the new one has no association
* with the old snapshot or its subscription, unless the same subscription is
* specified. (snapshots.delete)
*
* @param string $snapshot Required. The name of the snapshot to delete. Format
* is `projects/{project}/snapshots/{snap}`.
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function delete($snapshot, $optParams = [])
{
$params = ['snapshot' => $snapshot];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], PubsubEmpty::class);
}
/**
* Gets the configuration details of a snapshot. Snapshots are used in
* [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
* which allow you to manage message acknowledgments in bulk. That is, you can
* set the acknowledgment state of messages in an existing subscription to the
* state captured by a snapshot. (snapshots.get)
*
* @param string $snapshot Required. The name of the snapshot to get. Format is
* `projects/{project}/snapshots/{snap}`.
* @param array $optParams Optional parameters.
* @return Snapshot
* @throws \Google\Service\Exception
*/
public function get($snapshot, $optParams = [])
{
$params = ['snapshot' => $snapshot];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Snapshot::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (snapshots.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists the existing snapshots. Snapshots are used in [Seek](
* https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow
* you to manage message acknowledgments in bulk. That is, you can set the
* acknowledgment state of messages in an existing subscription to the state
* captured by a snapshot. (snapshots.listProjectsSnapshots)
*
* @param string $project Required. The name of the project in which to list
* snapshots. Format is `projects/{project-id}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. Maximum number of snapshots to return.
* @opt_param string pageToken Optional. The value returned by the last
* `ListSnapshotsResponse`; indicates that this is a continuation of a prior
* `ListSnapshots` call, and that the system should return the next page of
* data.
* @return ListSnapshotsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsSnapshots($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSnapshotsResponse::class);
}
/**
* Updates an existing snapshot by updating the fields specified in the update
* mask. Snapshots are used in
* [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
* which allow you to manage message acknowledgments in bulk. That is, you can
* set the acknowledgment state of messages in an existing subscription to the
* state captured by a snapshot. (snapshots.patch)
*
* @param string $name Optional. The name of the snapshot.
* @param UpdateSnapshotRequest $postBody
* @param array $optParams Optional parameters.
* @return Snapshot
* @throws \Google\Service\Exception
*/
public function patch($name, UpdateSnapshotRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Snapshot::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (snapshots.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning.
* (snapshots.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsSnapshots::class, 'Google_Service_Pubsub_Resource_ProjectsSnapshots');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsSubscriptions.php
Vendored
+348
View File
@@ -0,0 +1,348 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\AcknowledgeRequest;
use Google\Service\Pubsub\DetachSubscriptionResponse;
use Google\Service\Pubsub\ListSubscriptionsResponse;
use Google\Service\Pubsub\ModifyAckDeadlineRequest;
use Google\Service\Pubsub\ModifyPushConfigRequest;
use Google\Service\Pubsub\Policy;
use Google\Service\Pubsub\PubsubEmpty;
use Google\Service\Pubsub\PullRequest;
use Google\Service\Pubsub\PullResponse;
use Google\Service\Pubsub\SeekRequest;
use Google\Service\Pubsub\SeekResponse;
use Google\Service\Pubsub\SetIamPolicyRequest;
use Google\Service\Pubsub\Subscription;
use Google\Service\Pubsub\TestIamPermissionsRequest;
use Google\Service\Pubsub\TestIamPermissionsResponse;
use Google\Service\Pubsub\UpdateSubscriptionRequest;
/**
* The "subscriptions" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $subscriptions = $pubsubService->projects_subscriptions;
* </code>
*/
class ProjectsSubscriptions extends \Google\Service\Resource
{
/**
* Acknowledges the messages associated with the `ack_ids` in the
* `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages
* from the subscription. Acknowledging a message whose ack deadline has expired
* may succeed, but such a message may be redelivered later. Acknowledging a
* message more than once will not result in an error.
* (subscriptions.acknowledge)
*
* @param string $subscription Required. The subscription whose message is being
* acknowledged. Format is `projects/{project}/subscriptions/{sub}`.
* @param AcknowledgeRequest $postBody
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function acknowledge($subscription, AcknowledgeRequest $postBody, $optParams = [])
{
$params = ['subscription' => $subscription, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('acknowledge', [$params], PubsubEmpty::class);
}
/**
* Creates a subscription to a given topic. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). If the
* subscription already exists, returns `ALREADY_EXISTS`. If the corresponding
* topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the
* request, the server will assign a random name for this subscription on the
* same project as the topic, conforming to the [resource name format]
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names). The
* generated name is populated in the returned Subscription object. Note that
* for REST API requests, you must specify a name in the request.
* (subscriptions.create)
*
* @param string $name Required. Identifier. The name of the subscription. It
* must have the format `"projects/{project}/subscriptions/{subscription}"`.
* `{subscription}` must start with a letter, and contain only letters
* (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
* (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3
* and 255 characters in length, and it must not start with `"goog"`.
* @param Subscription $postBody
* @param array $optParams Optional parameters.
* @return Subscription
* @throws \Google\Service\Exception
*/
public function create($name, Subscription $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Subscription::class);
}
/**
* Deletes an existing subscription. All messages retained in the subscription
* are immediately dropped. Calls to `Pull` after deletion will return
* `NOT_FOUND`. After a subscription is deleted, a new one may be created with
* the same name, but the new one has no association with the old subscription
* or its topic unless the same topic is specified. (subscriptions.delete)
*
* @param string $subscription Required. The subscription to delete. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function delete($subscription, $optParams = [])
{
$params = ['subscription' => $subscription];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], PubsubEmpty::class);
}
/**
* Detaches a subscription from this topic. All messages retained in the
* subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will
* return FAILED_PRECONDITION. If the subscription is a push subscription,
* pushes to the endpoint will stop. (subscriptions.detach)
*
* @param string $subscription Required. The subscription to detach. Format is
* `projects/{project}/subscriptions/{subscription}`.
* @param array $optParams Optional parameters.
* @return DetachSubscriptionResponse
* @throws \Google\Service\Exception
*/
public function detach($subscription, $optParams = [])
{
$params = ['subscription' => $subscription];
$params = array_merge($params, $optParams);
return $this->call('detach', [$params], DetachSubscriptionResponse::class);
}
/**
* Gets the configuration details of a subscription. (subscriptions.get)
*
* @param string $subscription Required. The name of the subscription to get.
* Format is `projects/{project}/subscriptions/{sub}`.
* @param array $optParams Optional parameters.
* @return Subscription
* @throws \Google\Service\Exception
*/
public function get($subscription, $optParams = [])
{
$params = ['subscription' => $subscription];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Subscription::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (subscriptions.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists matching subscriptions. (subscriptions.listProjectsSubscriptions)
*
* @param string $project Required. The name of the project in which to list
* subscriptions. Format is `projects/{project-id}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. Maximum number of subscriptions to return.
* @opt_param string pageToken Optional. The value returned by the last
* `ListSubscriptionsResponse`; indicates that this is a continuation of a prior
* `ListSubscriptions` call, and that the system should return the next page of
* data.
* @return ListSubscriptionsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsSubscriptions($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListSubscriptionsResponse::class);
}
/**
* Modifies the ack deadline for a specific message. This method is useful to
* indicate that more time is needed to process a message by the subscriber, or
* to make the message available for redelivery if the processing was
* interrupted. Note that this does not modify the subscription-level
* `ackDeadlineSeconds` used for subsequent messages.
* (subscriptions.modifyAckDeadline)
*
* @param string $subscription Required. The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ModifyAckDeadlineRequest $postBody
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function modifyAckDeadline($subscription, ModifyAckDeadlineRequest $postBody, $optParams = [])
{
$params = ['subscription' => $subscription, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modifyAckDeadline', [$params], PubsubEmpty::class);
}
/**
* Modifies the `PushConfig` for a specified subscription. This may be used to
* change a push subscription to a pull one (signified by an empty `PushConfig`)
* or vice versa, or change the endpoint URL and other attributes of a push
* subscription. Messages will accumulate for delivery continuously through the
* call regardless of changes to the `PushConfig`.
* (subscriptions.modifyPushConfig)
*
* @param string $subscription Required. The name of the subscription. Format is
* `projects/{project}/subscriptions/{sub}`.
* @param ModifyPushConfigRequest $postBody
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function modifyPushConfig($subscription, ModifyPushConfigRequest $postBody, $optParams = [])
{
$params = ['subscription' => $subscription, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('modifyPushConfig', [$params], PubsubEmpty::class);
}
/**
* Updates an existing subscription by updating the fields specified in the
* update mask. Note that certain properties of a subscription, such as its
* topic, are not modifiable. (subscriptions.patch)
*
* @param string $name Required. Identifier. The name of the subscription. It
* must have the format `"projects/{project}/subscriptions/{subscription}"`.
* `{subscription}` must start with a letter, and contain only letters
* (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods
* (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3
* and 255 characters in length, and it must not start with `"goog"`.
* @param UpdateSubscriptionRequest $postBody
* @param array $optParams Optional parameters.
* @return Subscription
* @throws \Google\Service\Exception
*/
public function patch($name, UpdateSubscriptionRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Subscription::class);
}
/**
* Pulls messages from the server. (subscriptions.pull)
*
* @param string $subscription Required. The subscription from which messages
* should be pulled. Format is `projects/{project}/subscriptions/{sub}`.
* @param PullRequest $postBody
* @param array $optParams Optional parameters.
* @return PullResponse
* @throws \Google\Service\Exception
*/
public function pull($subscription, PullRequest $postBody, $optParams = [])
{
$params = ['subscription' => $subscription, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('pull', [$params], PullResponse::class);
}
/**
* Seeks an existing subscription to a point in time or to a given snapshot,
* whichever is provided in the request. Snapshots are used in [Seek]
* (https://cloud.google.com/pubsub/docs/replay-overview) operations, which
* allow you to manage message acknowledgments in bulk. That is, you can set the
* acknowledgment state of messages in an existing subscription to the state
* captured by a snapshot. Note that both the subscription and the snapshot must
* be on the same topic. (subscriptions.seek)
*
* @param string $subscription Required. The subscription to affect.
* @param SeekRequest $postBody
* @param array $optParams Optional parameters.
* @return SeekResponse
* @throws \Google\Service\Exception
*/
public function seek($subscription, SeekRequest $postBody, $optParams = [])
{
$params = ['subscription' => $subscription, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('seek', [$params], SeekResponse::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (subscriptions.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning.
* (subscriptions.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsSubscriptions::class, 'Google_Service_Pubsub_Resource_ProjectsSubscriptions');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsTopics.php
Vendored
+232
View File
@@ -0,0 +1,232 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\ListTopicsResponse;
use Google\Service\Pubsub\Policy;
use Google\Service\Pubsub\PublishRequest;
use Google\Service\Pubsub\PublishResponse;
use Google\Service\Pubsub\PubsubEmpty;
use Google\Service\Pubsub\SetIamPolicyRequest;
use Google\Service\Pubsub\TestIamPermissionsRequest;
use Google\Service\Pubsub\TestIamPermissionsResponse;
use Google\Service\Pubsub\Topic;
use Google\Service\Pubsub\UpdateTopicRequest;
/**
* The "topics" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $topics = $pubsubService->projects_topics;
* </code>
*/
class ProjectsTopics extends \Google\Service\Resource
{
/**
* Creates the given topic with the given name. See the [resource name rules]
* (https://cloud.google.com/pubsub/docs/pubsub-basics#resource_names).
* (topics.create)
*
* @param string $name Required. Identifier. The name of the topic. It must have
* the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a
* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
* (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
* signs (`%`). It must be between 3 and 255 characters in length, and it must
* not start with `"goog"`.
* @param Topic $postBody
* @param array $optParams Optional parameters.
* @return Topic
* @throws \Google\Service\Exception
*/
public function create($name, Topic $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('create', [$params], Topic::class);
}
/**
* Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does
* not exist. After a topic is deleted, a new topic may be created with the same
* name; this is an entirely new topic with none of the old configuration or
* subscriptions. Existing subscriptions to this topic are not deleted, but
* their `topic` field is set to `_deleted-topic_`. (topics.delete)
*
* @param string $topic Required. Name of the topic to delete. Format is
* `projects/{project}/topics/{topic}`.
* @param array $optParams Optional parameters.
* @return PubsubEmpty
* @throws \Google\Service\Exception
*/
public function delete($topic, $optParams = [])
{
$params = ['topic' => $topic];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params], PubsubEmpty::class);
}
/**
* Gets the configuration of a topic. (topics.get)
*
* @param string $topic Required. The name of the topic to get. Format is
* `projects/{project}/topics/{topic}`.
* @param array $optParams Optional parameters.
* @return Topic
* @throws \Google\Service\Exception
*/
public function get($topic, $optParams = [])
{
$params = ['topic' => $topic];
$params = array_merge($params, $optParams);
return $this->call('get', [$params], Topic::class);
}
/**
* Gets the access control policy for a resource. Returns an empty policy if the
* resource exists and does not have a policy set. (topics.getIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param array $optParams Optional parameters.
*
* @opt_param int options.requestedPolicyVersion Optional. The maximum policy
* version that will be used to format the policy. Valid values are 0, 1, and 3.
* Requests specifying an invalid value will be rejected. Requests for policies
* with any conditional role bindings must specify version 3. Policies with no
* conditional role bindings may specify any valid value or leave the field
* unset. The policy in the response might use the policy version that you
* specified, or it might use a lower policy version. For example, if you
* specify version 3, but the policy has no conditional role bindings, the
* response uses version 1. To learn which resources support conditions in their
* IAM policies, see the [IAM
* documentation](https://cloud.google.com/iam/help/conditions/resource-
* policies).
* @return Policy
* @throws \Google\Service\Exception
*/
public function getIamPolicy($resource, $optParams = [])
{
$params = ['resource' => $resource];
$params = array_merge($params, $optParams);
return $this->call('getIamPolicy', [$params], Policy::class);
}
/**
* Lists matching topics. (topics.listProjectsTopics)
*
* @param string $project Required. The name of the project in which to list
* topics. Format is `projects/{project-id}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. Maximum number of topics to return.
* @opt_param string pageToken Optional. The value returned by the last
* `ListTopicsResponse`; indicates that this is a continuation of a prior
* `ListTopics` call, and that the system should return the next page of data.
* @return ListTopicsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsTopics($project, $optParams = [])
{
$params = ['project' => $project];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListTopicsResponse::class);
}
/**
* Updates an existing topic by updating the fields specified in the update
* mask. Note that certain properties of a topic are not modifiable.
* (topics.patch)
*
* @param string $name Required. Identifier. The name of the topic. It must have
* the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a
* letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes
* (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
* signs (`%`). It must be between 3 and 255 characters in length, and it must
* not start with `"goog"`.
* @param UpdateTopicRequest $postBody
* @param array $optParams Optional parameters.
* @return Topic
* @throws \Google\Service\Exception
*/
public function patch($name, UpdateTopicRequest $postBody, $optParams = [])
{
$params = ['name' => $name, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('patch', [$params], Topic::class);
}
/**
* Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does
* not exist. (topics.publish)
*
* @param string $topic Required. The messages in the request will be published
* on this topic. Format is `projects/{project}/topics/{topic}`.
* @param PublishRequest $postBody
* @param array $optParams Optional parameters.
* @return PublishResponse
* @throws \Google\Service\Exception
*/
public function publish($topic, PublishRequest $postBody, $optParams = [])
{
$params = ['topic' => $topic, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('publish', [$params], PublishResponse::class);
}
/**
* Sets the access control policy on the specified resource. Replaces any
* existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and
* `PERMISSION_DENIED` errors. (topics.setIamPolicy)
*
* @param string $resource REQUIRED: The resource for which the policy is being
* specified. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param SetIamPolicyRequest $postBody
* @param array $optParams Optional parameters.
* @return Policy
* @throws \Google\Service\Exception
*/
public function setIamPolicy($resource, SetIamPolicyRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('setIamPolicy', [$params], Policy::class);
}
/**
* Returns permissions that a caller has on the specified resource. If the
* resource does not exist, this will return an empty set of permissions, not a
* `NOT_FOUND` error. Note: This operation is designed to be used for building
* permission-aware UIs and command-line tools, not for authorization checking.
* This operation may "fail open" without warning. (topics.testIamPermissions)
*
* @param string $resource REQUIRED: The resource for which the policy detail is
* being requested. See [Resource
* names](https://cloud.google.com/apis/design/resource_names) for the
* appropriate value for this field.
* @param TestIamPermissionsRequest $postBody
* @param array $optParams Optional parameters.
* @return TestIamPermissionsResponse
* @throws \Google\Service\Exception
*/
public function testIamPermissions($resource, TestIamPermissionsRequest $postBody, $optParams = [])
{
$params = ['resource' => $resource, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('testIamPermissions', [$params], TestIamPermissionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsTopics::class, 'Google_Service_Pubsub_Resource_ProjectsTopics');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsTopicsSnapshots.php
Vendored
+60
View File
@@ -0,0 +1,60 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\ListTopicSnapshotsResponse;
/**
* The "snapshots" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $snapshots = $pubsubService->projects_topics_snapshots;
* </code>
*/
class ProjectsTopicsSnapshots extends \Google\Service\Resource
{
/**
* Lists the names of the snapshots on this topic. Snapshots are used in
* [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,
* which allow you to manage message acknowledgments in bulk. That is, you can
* set the acknowledgment state of messages in an existing subscription to the
* state captured by a snapshot. (snapshots.listProjectsTopicsSnapshots)
*
* @param string $topic Required. The name of the topic that snapshots are
* attached to. Format is `projects/{project}/topics/{topic}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. Maximum number of snapshot names to return.
* @opt_param string pageToken Optional. The value returned by the last
* `ListTopicSnapshotsResponse`; indicates that this is a continuation of a
* prior `ListTopicSnapshots` call, and that the system should return the next
* page of data.
* @return ListTopicSnapshotsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsTopicsSnapshots($topic, $optParams = [])
{
$params = ['topic' => $topic];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListTopicSnapshotsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsTopicsSnapshots::class, 'Google_Service_Pubsub_Resource_ProjectsTopicsSnapshots');
vendor/google/apiclient-services/src/Pubsub/Resource/ProjectsTopicsSubscriptions.php
Vendored
+58
View File
@@ -0,0 +1,58 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub\Resource;
use Google\Service\Pubsub\ListTopicSubscriptionsResponse;
/**
* The "subscriptions" collection of methods.
* Typical usage is:
* <code>
* $pubsubService = new Google\Service\Pubsub(...);
* $subscriptions = $pubsubService->projects_topics_subscriptions;
* </code>
*/
class ProjectsTopicsSubscriptions extends \Google\Service\Resource
{
/**
* Lists the names of the attached subscriptions on this topic.
* (subscriptions.listProjectsTopicsSubscriptions)
*
* @param string $topic Required. The name of the topic that subscriptions are
* attached to. Format is `projects/{project}/topics/{topic}`.
* @param array $optParams Optional parameters.
*
* @opt_param int pageSize Optional. Maximum number of subscription names to
* return.
* @opt_param string pageToken Optional. The value returned by the last
* `ListTopicSubscriptionsResponse`; indicates that this is a continuation of a
* prior `ListTopicSubscriptions` call, and that the system should return the
* next page of data.
* @return ListTopicSubscriptionsResponse
* @throws \Google\Service\Exception
*/
public function listProjectsTopicsSubscriptions($topic, $optParams = [])
{
$params = ['topic' => $topic];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], ListTopicSubscriptionsResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ProjectsTopicsSubscriptions::class, 'Google_Service_Pubsub_Resource_ProjectsTopicsSubscriptions');
vendor/google/apiclient-services/src/Pubsub/RetryPolicy.php
Vendored
+76
View File
@@ -0,0 +1,76 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class RetryPolicy extends \Google\Model
{
/**
* Optional. The maximum delay between consecutive deliveries of a given
* message. Value should be between 0 and 600 seconds. Defaults to 600
* seconds.
*
* @var string
*/
public $maximumBackoff;
/**
* Optional. The minimum delay between consecutive deliveries of a given
* message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
*
* @var string
*/
public $minimumBackoff;
/**
* Optional. The maximum delay between consecutive deliveries of a given
* message. Value should be between 0 and 600 seconds. Defaults to 600
* seconds.
*
* @param string $maximumBackoff
*/
public function setMaximumBackoff($maximumBackoff)
{
$this->maximumBackoff = $maximumBackoff;
}
/**
* @return string
*/
public function getMaximumBackoff()
{
return $this->maximumBackoff;
}
/**
* Optional. The minimum delay between consecutive deliveries of a given
* message. Value should be between 0 and 600 seconds. Defaults to 10 seconds.
*
* @param string $minimumBackoff
*/
public function setMinimumBackoff($minimumBackoff)
{
$this->minimumBackoff = $minimumBackoff;
}
/**
* @return string
*/
public function getMinimumBackoff()
{
return $this->minimumBackoff;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RetryPolicy::class, 'Google_Service_Pubsub_RetryPolicy');
vendor/google/apiclient-services/src/Pubsub/RollbackSchemaRequest.php
Vendored
+50
View File
@@ -0,0 +1,50 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class RollbackSchemaRequest extends \Google\Model
{
/**
* Required. The revision ID to roll back to. It must be a revision of the
* same schema. Example: c7cfa2a8
*
* @var string
*/
public $revisionId;
/**
* Required. The revision ID to roll back to. It must be a revision of the
* same schema. Example: c7cfa2a8
*
* @param string $revisionId
*/
public function setRevisionId($revisionId)
{
$this->revisionId = $revisionId;
}
/**
* @return string
*/
public function getRevisionId()
{
return $this->revisionId;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(RollbackSchemaRequest::class, 'Google_Service_Pubsub_RollbackSchemaRequest');
vendor/google/apiclient-services/src/Pubsub/Schema.php
Vendored
+156
View File
@@ -0,0 +1,156 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Schema extends \Google\Model
{
/**
* Default value. This value is unused.
*/
public const TYPE_TYPE_UNSPECIFIED = 'TYPE_UNSPECIFIED';
/**
* A Protocol Buffer schema definition.
*/
public const TYPE_PROTOCOL_BUFFER = 'PROTOCOL_BUFFER';
/**
* An Avro schema definition.
*/
public const TYPE_AVRO = 'AVRO';
/**
* The definition of the schema. This should contain a string representing the
* full definition of the schema that is a valid schema definition of the type
* specified in `type`.
*
* @var string
*/
public $definition;
/**
* Required. Name of the schema. Format is
* `projects/{project}/schemas/{schema}`.
*
* @var string
*/
public $name;
/**
* Output only. The timestamp that the revision was created.
*
* @var string
*/
public $revisionCreateTime;
/**
* Output only. Immutable. The revision ID of the schema.
*
* @var string
*/
public $revisionId;
/**
* The type of the schema definition.
*
* @var string
*/
public $type;
/**
* The definition of the schema. This should contain a string representing the
* full definition of the schema that is a valid schema definition of the type
* specified in `type`.
*
* @param string $definition
*/
public function setDefinition($definition)
{
$this->definition = $definition;
}
/**
* @return string
*/
public function getDefinition()
{
return $this->definition;
}
/**
* Required. Name of the schema. Format is
* `projects/{project}/schemas/{schema}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Output only. The timestamp that the revision was created.
*
* @param string $revisionCreateTime
*/
public function setRevisionCreateTime($revisionCreateTime)
{
$this->revisionCreateTime = $revisionCreateTime;
}
/**
* @return string
*/
public function getRevisionCreateTime()
{
return $this->revisionCreateTime;
}
/**
* Output only. Immutable. The revision ID of the schema.
*
* @param string $revisionId
*/
public function setRevisionId($revisionId)
{
$this->revisionId = $revisionId;
}
/**
* @return string
*/
public function getRevisionId()
{
return $this->revisionId;
}
/**
* The type of the schema definition.
*
* Accepted values: TYPE_UNSPECIFIED, PROTOCOL_BUFFER, AVRO
*
* @param self::TYPE_* $type
*/
public function setType($type)
{
$this->type = $type;
}
/**
* @return self::TYPE_*
*/
public function getType()
{
return $this->type;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Schema::class, 'Google_Service_Pubsub_Schema');
vendor/google/apiclient-services/src/Pubsub/SchemaSettings.php
Vendored
+143
View File
@@ -0,0 +1,143 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class SchemaSettings extends \Google\Model
{
/**
* Unspecified
*/
public const ENCODING_ENCODING_UNSPECIFIED = 'ENCODING_UNSPECIFIED';
/**
* JSON encoding
*/
public const ENCODING_JSON = 'JSON';
/**
* Binary encoding, as defined by the schema type. For some schema types,
* binary encoding may not be available.
*/
public const ENCODING_BINARY = 'BINARY';
/**
* Optional. The encoding of messages validated against `schema`.
*
* @var string
*/
public $encoding;
/**
* Optional. The minimum (inclusive) revision allowed for validating messages.
* If empty or not present, allow any revision to be validated against
* last_revision or any revision created before.
*
* @var string
*/
public $firstRevisionId;
/**
* Optional. The maximum (inclusive) revision allowed for validating messages.
* If empty or not present, allow any revision to be validated against
* first_revision or any revision created after.
*
* @var string
*/
public $lastRevisionId;
/**
* Required. The name of the schema that messages published should be
* validated against. Format is `projects/{project}/schemas/{schema}`. The
* value of this field will be `_deleted-schema_` if the schema has been
* deleted.
*
* @var string
*/
public $schema;
/**
* Optional. The encoding of messages validated against `schema`.
*
* Accepted values: ENCODING_UNSPECIFIED, JSON, BINARY
*
* @param self::ENCODING_* $encoding
*/
public function setEncoding($encoding)
{
$this->encoding = $encoding;
}
/**
* @return self::ENCODING_*
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Optional. The minimum (inclusive) revision allowed for validating messages.
* If empty or not present, allow any revision to be validated against
* last_revision or any revision created before.
*
* @param string $firstRevisionId
*/
public function setFirstRevisionId($firstRevisionId)
{
$this->firstRevisionId = $firstRevisionId;
}
/**
* @return string
*/
public function getFirstRevisionId()
{
return $this->firstRevisionId;
}
/**
* Optional. The maximum (inclusive) revision allowed for validating messages.
* If empty or not present, allow any revision to be validated against
* first_revision or any revision created after.
*
* @param string $lastRevisionId
*/
public function setLastRevisionId($lastRevisionId)
{
$this->lastRevisionId = $lastRevisionId;
}
/**
* @return string
*/
public function getLastRevisionId()
{
return $this->lastRevisionId;
}
/**
* Required. The name of the schema that messages published should be
* validated against. Format is `projects/{project}/schemas/{schema}`. The
* value of this field will be `_deleted-schema_` if the schema has been
* deleted.
*
* @param string $schema
*/
public function setSchema($schema)
{
$this->schema = $schema;
}
/**
* @return string
*/
public function getSchema()
{
return $this->schema;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SchemaSettings::class, 'Google_Service_Pubsub_SchemaSettings');
vendor/google/apiclient-services/src/Pubsub/SeekRequest.php
Vendored
+92
View File
@@ -0,0 +1,92 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class SeekRequest extends \Google\Model
{
/**
* Optional. The snapshot to seek to. The snapshot's topic must be the same as
* that of the provided subscription. Format is
* `projects/{project}/snapshots/{snap}`.
*
* @var string
*/
public $snapshot;
/**
* Optional. The time to seek to. Messages retained in the subscription that
* were published before this time are marked as acknowledged, and messages
* retained in the subscription that were published after this time are marked
* as unacknowledged. Note that this operation affects only those messages
* retained in the subscription (configured by the combination of
* `message_retention_duration` and `retain_acked_messages`). For example, if
* `time` corresponds to a point before the message retention window (or to a
* point before the system's notion of the subscription creation time), only
* retained messages will be marked as unacknowledged, and already-expunged
* messages will not be restored.
*
* @var string
*/
public $time;
/**
* Optional. The snapshot to seek to. The snapshot's topic must be the same as
* that of the provided subscription. Format is
* `projects/{project}/snapshots/{snap}`.
*
* @param string $snapshot
*/
public function setSnapshot($snapshot)
{
$this->snapshot = $snapshot;
}
/**
* @return string
*/
public function getSnapshot()
{
return $this->snapshot;
}
/**
* Optional. The time to seek to. Messages retained in the subscription that
* were published before this time are marked as acknowledged, and messages
* retained in the subscription that were published after this time are marked
* as unacknowledged. Note that this operation affects only those messages
* retained in the subscription (configured by the combination of
* `message_retention_duration` and `retain_acked_messages`). For example, if
* `time` corresponds to a point before the message retention window (or to a
* point before the system's notion of the subscription creation time), only
* retained messages will be marked as unacknowledged, and already-expunged
* messages will not be restored.
*
* @param string $time
*/
public function setTime($time)
{
$this->time = $time;
}
/**
* @return string
*/
public function getTime()
{
return $this->time;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SeekRequest::class, 'Google_Service_Pubsub_SeekRequest');
vendor/google/apiclient-services/src/Pubsub/SeekResponse.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class SeekResponse extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SeekResponse::class, 'Google_Service_Pubsub_SeekResponse');
vendor/google/apiclient-services/src/Pubsub/SetIamPolicyRequest.php
Vendored
+46
View File
@@ -0,0 +1,46 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class SetIamPolicyRequest extends \Google\Model
{
protected $policyType = Policy::class;
protected $policyDataType = '';
/**
* REQUIRED: The complete policy to be applied to the `resource`. The size of
* the policy is limited to a few 10s of KB. An empty policy is a valid policy
* but certain Google Cloud services (such as Projects) might reject them.
*
* @param Policy $policy
*/
public function setPolicy(Policy $policy)
{
$this->policy = $policy;
}
/**
* @return Policy
*/
public function getPolicy()
{
return $this->policy;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(SetIamPolicyRequest::class, 'Google_Service_Pubsub_SetIamPolicyRequest');
vendor/google/apiclient-services/src/Pubsub/Snapshot.php
Vendored
+136
View File
@@ -0,0 +1,136 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Snapshot extends \Google\Model
{
/**
* Optional. The snapshot is guaranteed to exist up until this time. A newly-
* created snapshot expires no later than 7 days from the time of its
* creation. Its exact lifetime is determined at creation by the existing
* backlog in the source subscription. Specifically, the lifetime of the
* snapshot is `7 days - (age of oldest unacked message in the subscription)`.
* For example, consider a subscription whose oldest unacked message is 3 days
* old. If a snapshot is created from this subscription, the snapshot -- which
* will always capture this 3-day-old backlog as long as the snapshot exists
* -- will expire in 4 days. The service will refuse to create a snapshot that
* would expire in less than 1 hour after creation.
*
* @var string
*/
public $expireTime;
/**
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
* @var string[]
*/
public $labels;
/**
* Optional. The name of the snapshot.
*
* @var string
*/
public $name;
/**
* Optional. The name of the topic from which this snapshot is retaining
* messages.
*
* @var string
*/
public $topic;
/**
* Optional. The snapshot is guaranteed to exist up until this time. A newly-
* created snapshot expires no later than 7 days from the time of its
* creation. Its exact lifetime is determined at creation by the existing
* backlog in the source subscription. Specifically, the lifetime of the
* snapshot is `7 days - (age of oldest unacked message in the subscription)`.
* For example, consider a subscription whose oldest unacked message is 3 days
* old. If a snapshot is created from this subscription, the snapshot -- which
* will always capture this 3-day-old backlog as long as the snapshot exists
* -- will expire in 4 days. The service will refuse to create a snapshot that
* would expire in less than 1 hour after creation.
*
* @param string $expireTime
*/
public function setExpireTime($expireTime)
{
$this->expireTime = $expireTime;
}
/**
* @return string
*/
public function getExpireTime()
{
return $this->expireTime;
}
/**
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Optional. The name of the snapshot.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Optional. The name of the topic from which this snapshot is retaining
* messages.
*
* @param string $topic
*/
public function setTopic($topic)
{
$this->topic = $topic;
}
/**
* @return string
*/
public function getTopic()
{
return $this->topic;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Snapshot::class, 'Google_Service_Pubsub_Snapshot');
vendor/google/apiclient-services/src/Pubsub/Subscription.php
Vendored
+632
View File
@@ -0,0 +1,632 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Subscription extends \Google\Collection
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The subscription can actively receive messages
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* The subscription cannot receive messages because of an error with the
* resource to which it pushes messages. See the more detailed error state in
* the corresponding configuration.
*/
public const STATE_RESOURCE_ERROR = 'RESOURCE_ERROR';
protected $collection_key = 'messageTransforms';
/**
* Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
* waits for the subscriber to acknowledge receipt before resending the
* message. In the interval after the message is delivered and before it is
* acknowledged, it is considered to be _outstanding_. During that time
* period, the message will not be redelivered (on a best-effort basis). For
* pull subscriptions, this value is used as the initial value for the ack
* deadline. To override this value for a given message, call
* `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming
* pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using
* streaming pull. The minimum custom deadline you can specify is 10 seconds.
* The maximum custom deadline you can specify is 600 seconds (10 minutes). If
* this parameter is 0, a default value of 10 seconds is used. For push
* delivery, this value is also used to set the request timeout for the call
* to the push endpoint. If the subscriber never acknowledges the message, the
* Pub/Sub system will eventually redeliver the message.
*
* @var int
*/
public $ackDeadlineSeconds;
protected $analyticsHubSubscriptionInfoType = AnalyticsHubSubscriptionInfo::class;
protected $analyticsHubSubscriptionInfoDataType = '';
protected $bigqueryConfigType = BigQueryConfig::class;
protected $bigqueryConfigDataType = '';
protected $bigtableConfigType = BigtableConfig::class;
protected $bigtableConfigDataType = '';
protected $cloudStorageConfigType = CloudStorageConfig::class;
protected $cloudStorageConfigDataType = '';
protected $deadLetterPolicyType = DeadLetterPolicy::class;
protected $deadLetterPolicyDataType = '';
/**
* Optional. Indicates whether the subscription is detached from its topic.
* Detached subscriptions don't receive messages from their topic and don't
* retain any backlog. `Pull` and `StreamingPull` requests will return
* FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
* the endpoint will not be made.
*
* @var bool
*/
public $detached;
/**
* Optional. If true, Pub/Sub provides the following guarantees for the
* delivery of a message with a given value of `message_id` on this
* subscription: * The message sent to a subscriber is guaranteed not to be
* resent before the message's acknowledgment deadline expires. * An
* acknowledged message will not be resent to a subscriber. Note that
* subscribers may still receive multiple copies of a message when
* `enable_exactly_once_delivery` is true if the message was published
* multiple times by a publisher client. These copies are considered distinct
* by Pub/Sub and have distinct `message_id` values.
*
* @var bool
*/
public $enableExactlyOnceDelivery;
/**
* Optional. If true, messages published with the same `ordering_key` in
* `PubsubMessage` will be delivered to the subscribers in the order in which
* they are received by the Pub/Sub system. Otherwise, they may be delivered
* in any order.
*
* @var bool
*/
public $enableMessageOrdering;
protected $expirationPolicyType = ExpirationPolicy::class;
protected $expirationPolicyDataType = '';
/**
* Optional. An expression written in the Pub/Sub [filter
* language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
* then only `PubsubMessage`s whose `attributes` field matches the filter are
* delivered on this subscription. If empty, then no messages are filtered
* out.
*
* @var string
*/
public $filter;
/**
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
* @var string[]
*/
public $labels;
/**
* Optional. How long to retain unacknowledged messages in the subscription's
* backlog, from the moment a message is published. If `retain_acked_messages`
* is true, then this also configures the retention of acknowledged messages,
* and thus configures how far back in time a `Seek` can be done. Defaults to
* 7 days. Cannot be more than 31 days or less than 10 minutes.
*
* @var string
*/
public $messageRetentionDuration;
protected $messageTransformsType = MessageTransform::class;
protected $messageTransformsDataType = 'array';
/**
* Required. Identifier. The name of the subscription. It must have the format
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
* start with a letter, and contain only letters (`[A-Za-z]`), numbers
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
* plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
* in length, and it must not start with `"goog"`.
*
* @var string
*/
public $name;
protected $pushConfigType = PushConfig::class;
protected $pushConfigDataType = '';
/**
* Optional. Indicates whether to retain acknowledged messages. If true, then
* messages are not expunged from the subscription's backlog, even if they are
* acknowledged, until they fall out of the `message_retention_duration`
* window. This must be true if you would like to [`Seek` to a timestamp]
* (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
* the past to replay previously-acknowledged messages.
*
* @var bool
*/
public $retainAckedMessages;
protected $retryPolicyType = RetryPolicy::class;
protected $retryPolicyDataType = '';
/**
* Output only. An output-only field indicating whether or not the
* subscription can receive messages.
*
* @var string
*/
public $state;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @var string[]
*/
public $tags;
/**
* Required. The name of the topic from which this subscription is receiving
* messages. Format is `projects/{project}/topics/{topic}`. The value of this
* field will be `_deleted-topic_` if the topic has been deleted.
*
* @var string
*/
public $topic;
/**
* Output only. Indicates the minimum duration for which a message is retained
* after it is published to the subscription's topic. If this field is set,
* messages published to the subscription's topic in the last
* `topic_message_retention_duration` are always available to subscribers. See
* the `message_retention_duration` field in `Topic`. This field is set only
* in responses from the server; it is ignored if it is set in any requests.
*
* @var string
*/
public $topicMessageRetentionDuration;
/**
* Optional. The approximate amount of time (on a best-effort basis) Pub/Sub
* waits for the subscriber to acknowledge receipt before resending the
* message. In the interval after the message is delivered and before it is
* acknowledged, it is considered to be _outstanding_. During that time
* period, the message will not be redelivered (on a best-effort basis). For
* pull subscriptions, this value is used as the initial value for the ack
* deadline. To override this value for a given message, call
* `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming
* pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using
* streaming pull. The minimum custom deadline you can specify is 10 seconds.
* The maximum custom deadline you can specify is 600 seconds (10 minutes). If
* this parameter is 0, a default value of 10 seconds is used. For push
* delivery, this value is also used to set the request timeout for the call
* to the push endpoint. If the subscriber never acknowledges the message, the
* Pub/Sub system will eventually redeliver the message.
*
* @param int $ackDeadlineSeconds
*/
public function setAckDeadlineSeconds($ackDeadlineSeconds)
{
$this->ackDeadlineSeconds = $ackDeadlineSeconds;
}
/**
* @return int
*/
public function getAckDeadlineSeconds()
{
return $this->ackDeadlineSeconds;
}
/**
* Output only. Information about the associated Analytics Hub subscription.
* Only set if the subscription is created by Analytics Hub.
*
* @param AnalyticsHubSubscriptionInfo $analyticsHubSubscriptionInfo
*/
public function setAnalyticsHubSubscriptionInfo(AnalyticsHubSubscriptionInfo $analyticsHubSubscriptionInfo)
{
$this->analyticsHubSubscriptionInfo = $analyticsHubSubscriptionInfo;
}
/**
* @return AnalyticsHubSubscriptionInfo
*/
public function getAnalyticsHubSubscriptionInfo()
{
return $this->analyticsHubSubscriptionInfo;
}
/**
* Optional. If delivery to BigQuery is used with this subscription, this
* field is used to configure it.
*
* @param BigQueryConfig $bigqueryConfig
*/
public function setBigqueryConfig(BigQueryConfig $bigqueryConfig)
{
$this->bigqueryConfig = $bigqueryConfig;
}
/**
* @return BigQueryConfig
*/
public function getBigqueryConfig()
{
return $this->bigqueryConfig;
}
/**
* Optional. If delivery to Bigtable is used with this subscription, this
* field is used to configure it.
*
* @param BigtableConfig $bigtableConfig
*/
public function setBigtableConfig(BigtableConfig $bigtableConfig)
{
$this->bigtableConfig = $bigtableConfig;
}
/**
* @return BigtableConfig
*/
public function getBigtableConfig()
{
return $this->bigtableConfig;
}
/**
* Optional. If delivery to Google Cloud Storage is used with this
* subscription, this field is used to configure it.
*
* @param CloudStorageConfig $cloudStorageConfig
*/
public function setCloudStorageConfig(CloudStorageConfig $cloudStorageConfig)
{
$this->cloudStorageConfig = $cloudStorageConfig;
}
/**
* @return CloudStorageConfig
*/
public function getCloudStorageConfig()
{
return $this->cloudStorageConfig;
}
/**
* Optional. A policy that specifies the conditions for dead lettering
* messages in this subscription. If dead_letter_policy is not set, dead
* lettering is disabled. The Pub/Sub service account associated with this
* subscriptions's parent project (i.e., service-{project_number}@gcp-sa-
* pubsub.iam.gserviceaccount.com) must have permission to Acknowledge()
* messages on this subscription.
*
* @param DeadLetterPolicy $deadLetterPolicy
*/
public function setDeadLetterPolicy(DeadLetterPolicy $deadLetterPolicy)
{
$this->deadLetterPolicy = $deadLetterPolicy;
}
/**
* @return DeadLetterPolicy
*/
public function getDeadLetterPolicy()
{
return $this->deadLetterPolicy;
}
/**
* Optional. Indicates whether the subscription is detached from its topic.
* Detached subscriptions don't receive messages from their topic and don't
* retain any backlog. `Pull` and `StreamingPull` requests will return
* FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
* the endpoint will not be made.
*
* @param bool $detached
*/
public function setDetached($detached)
{
$this->detached = $detached;
}
/**
* @return bool
*/
public function getDetached()
{
return $this->detached;
}
/**
* Optional. If true, Pub/Sub provides the following guarantees for the
* delivery of a message with a given value of `message_id` on this
* subscription: * The message sent to a subscriber is guaranteed not to be
* resent before the message's acknowledgment deadline expires. * An
* acknowledged message will not be resent to a subscriber. Note that
* subscribers may still receive multiple copies of a message when
* `enable_exactly_once_delivery` is true if the message was published
* multiple times by a publisher client. These copies are considered distinct
* by Pub/Sub and have distinct `message_id` values.
*
* @param bool $enableExactlyOnceDelivery
*/
public function setEnableExactlyOnceDelivery($enableExactlyOnceDelivery)
{
$this->enableExactlyOnceDelivery = $enableExactlyOnceDelivery;
}
/**
* @return bool
*/
public function getEnableExactlyOnceDelivery()
{
return $this->enableExactlyOnceDelivery;
}
/**
* Optional. If true, messages published with the same `ordering_key` in
* `PubsubMessage` will be delivered to the subscribers in the order in which
* they are received by the Pub/Sub system. Otherwise, they may be delivered
* in any order.
*
* @param bool $enableMessageOrdering
*/
public function setEnableMessageOrdering($enableMessageOrdering)
{
$this->enableMessageOrdering = $enableMessageOrdering;
}
/**
* @return bool
*/
public function getEnableMessageOrdering()
{
return $this->enableMessageOrdering;
}
/**
* Optional. A policy that specifies the conditions for this subscription's
* expiration. A subscription is considered active as long as any connected
* subscriber is successfully consuming messages from the subscription or is
* issuing operations on the subscription. If `expiration_policy` is not set,
* a *default policy* with `ttl` of 31 days will be used. The minimum allowed
* value for `expiration_policy.ttl` is 1 day. If `expiration_policy` is set,
* but `expiration_policy.ttl` is not set, the subscription never expires.
*
* @param ExpirationPolicy $expirationPolicy
*/
public function setExpirationPolicy(ExpirationPolicy $expirationPolicy)
{
$this->expirationPolicy = $expirationPolicy;
}
/**
* @return ExpirationPolicy
*/
public function getExpirationPolicy()
{
return $this->expirationPolicy;
}
/**
* Optional. An expression written in the Pub/Sub [filter
* language](https://cloud.google.com/pubsub/docs/filtering). If non-empty,
* then only `PubsubMessage`s whose `attributes` field matches the filter are
* delivered on this subscription. If empty, then no messages are filtered
* out.
*
* @param string $filter
*/
public function setFilter($filter)
{
$this->filter = $filter;
}
/**
* @return string
*/
public function getFilter()
{
return $this->filter;
}
/**
* Optional. See [Creating and managing
* labels](https://cloud.google.com/pubsub/docs/labels).
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Optional. How long to retain unacknowledged messages in the subscription's
* backlog, from the moment a message is published. If `retain_acked_messages`
* is true, then this also configures the retention of acknowledged messages,
* and thus configures how far back in time a `Seek` can be done. Defaults to
* 7 days. Cannot be more than 31 days or less than 10 minutes.
*
* @param string $messageRetentionDuration
*/
public function setMessageRetentionDuration($messageRetentionDuration)
{
$this->messageRetentionDuration = $messageRetentionDuration;
}
/**
* @return string
*/
public function getMessageRetentionDuration()
{
return $this->messageRetentionDuration;
}
/**
* Optional. Transforms to be applied to messages before they are delivered to
* subscribers. Transforms are applied in the order specified.
*
* @param MessageTransform[] $messageTransforms
*/
public function setMessageTransforms($messageTransforms)
{
$this->messageTransforms = $messageTransforms;
}
/**
* @return MessageTransform[]
*/
public function getMessageTransforms()
{
return $this->messageTransforms;
}
/**
* Required. Identifier. The name of the subscription. It must have the format
* `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
* start with a letter, and contain only letters (`[A-Za-z]`), numbers
* (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
* plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
* in length, and it must not start with `"goog"`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Optional. If push delivery is used with this subscription, this field is
* used to configure it.
*
* @param PushConfig $pushConfig
*/
public function setPushConfig(PushConfig $pushConfig)
{
$this->pushConfig = $pushConfig;
}
/**
* @return PushConfig
*/
public function getPushConfig()
{
return $this->pushConfig;
}
/**
* Optional. Indicates whether to retain acknowledged messages. If true, then
* messages are not expunged from the subscription's backlog, even if they are
* acknowledged, until they fall out of the `message_retention_duration`
* window. This must be true if you would like to [`Seek` to a timestamp]
* (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in
* the past to replay previously-acknowledged messages.
*
* @param bool $retainAckedMessages
*/
public function setRetainAckedMessages($retainAckedMessages)
{
$this->retainAckedMessages = $retainAckedMessages;
}
/**
* @return bool
*/
public function getRetainAckedMessages()
{
return $this->retainAckedMessages;
}
/**
* Optional. A policy that specifies how Pub/Sub retries message delivery for
* this subscription. If not set, the default retry policy is applied. This
* generally implies that messages will be retried as soon as possible for
* healthy subscribers. RetryPolicy will be triggered on NACKs or
* acknowledgment deadline exceeded events for a given message.
*
* @param RetryPolicy $retryPolicy
*/
public function setRetryPolicy(RetryPolicy $retryPolicy)
{
$this->retryPolicy = $retryPolicy;
}
/**
* @return RetryPolicy
*/
public function getRetryPolicy()
{
return $this->retryPolicy;
}
/**
* Output only. An output-only field indicating whether or not the
* subscription can receive messages.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, RESOURCE_ERROR
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
/**
* Required. The name of the topic from which this subscription is receiving
* messages. Format is `projects/{project}/topics/{topic}`. The value of this
* field will be `_deleted-topic_` if the topic has been deleted.
*
* @param string $topic
*/
public function setTopic($topic)
{
$this->topic = $topic;
}
/**
* @return string
*/
public function getTopic()
{
return $this->topic;
}
/**
* Output only. Indicates the minimum duration for which a message is retained
* after it is published to the subscription's topic. If this field is set,
* messages published to the subscription's topic in the last
* `topic_message_retention_duration` are always available to subscribers. See
* the `message_retention_duration` field in `Topic`. This field is set only
* in responses from the server; it is ignored if it is set in any requests.
*
* @param string $topicMessageRetentionDuration
*/
public function setTopicMessageRetentionDuration($topicMessageRetentionDuration)
{
$this->topicMessageRetentionDuration = $topicMessageRetentionDuration;
}
/**
* @return string
*/
public function getTopicMessageRetentionDuration()
{
return $this->topicMessageRetentionDuration;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Subscription::class, 'Google_Service_Pubsub_Subscription');
vendor/google/apiclient-services/src/Pubsub/TestIamPermissionsRequest.php
Vendored
+55
View File
@@ -0,0 +1,55 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class TestIamPermissionsRequest extends \Google\Collection
{
protected $collection_key = 'permissions';
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as `*` or `storage.*`) are not allowed. For more
* information see [IAM
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
*
* @var string[]
*/
public $permissions;
/**
* The set of permissions to check for the `resource`. Permissions with
* wildcards (such as `*` or `storage.*`) are not allowed. For more
* information see [IAM
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
*
* @param string[] $permissions
*/
public function setPermissions($permissions)
{
$this->permissions = $permissions;
}
/**
* @return string[]
*/
public function getPermissions()
{
return $this->permissions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TestIamPermissionsRequest::class, 'Google_Service_Pubsub_TestIamPermissionsRequest');
vendor/google/apiclient-services/src/Pubsub/TestIamPermissionsResponse.php
Vendored
+51
View File
@@ -0,0 +1,51 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class TestIamPermissionsResponse extends \Google\Collection
{
protected $collection_key = 'permissions';
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*
* @var string[]
*/
public $permissions;
/**
* A subset of `TestPermissionsRequest.permissions` that the caller is
* allowed.
*
* @param string[] $permissions
*/
public function setPermissions($permissions)
{
$this->permissions = $permissions;
}
/**
* @return string[]
*/
public function getPermissions()
{
return $this->permissions;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TestIamPermissionsResponse::class, 'Google_Service_Pubsub_TestIamPermissionsResponse');
vendor/google/apiclient-services/src/Pubsub/TextConfig.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class TextConfig extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TextConfig::class, 'Google_Service_Pubsub_TextConfig');
vendor/google/apiclient-services/src/Pubsub/TextFormat.php
Vendored
+48
View File
@@ -0,0 +1,48 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class TextFormat extends \Google\Model
{
/**
* Optional. When unset, '\n' is used.
*
* @var string
*/
public $delimiter;
/**
* Optional. When unset, '\n' is used.
*
* @param string $delimiter
*/
public function setDelimiter($delimiter)
{
$this->delimiter = $delimiter;
}
/**
* @return string
*/
public function getDelimiter()
{
return $this->delimiter;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(TextFormat::class, 'Google_Service_Pubsub_TextFormat');
vendor/google/apiclient-services/src/Pubsub/Topic.php
Vendored
+314
View File
@@ -0,0 +1,314 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class Topic extends \Google\Collection
{
/**
* Default value. This value is unused.
*/
public const STATE_STATE_UNSPECIFIED = 'STATE_UNSPECIFIED';
/**
* The topic does not have any persistent errors.
*/
public const STATE_ACTIVE = 'ACTIVE';
/**
* Ingestion from the data source has encountered a permanent error. See the
* more detailed error state in the corresponding ingestion source
* configuration.
*/
public const STATE_INGESTION_RESOURCE_ERROR = 'INGESTION_RESOURCE_ERROR';
protected $collection_key = 'messageTransforms';
protected $ingestionDataSourceSettingsType = IngestionDataSourceSettings::class;
protected $ingestionDataSourceSettingsDataType = '';
/**
* Optional. The resource name of the Cloud KMS CryptoKey to be used to
* protect access to messages published on this topic. The expected format is
* `projects/locations/keyRings/cryptoKeys`.
*
* @var string
*/
public $kmsKeyName;
/**
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
* @var string[]
*/
public $labels;
/**
* Optional. Indicates the minimum duration to retain a message after it is
* published to the topic. If this field is set, messages published to the
* topic in the last `message_retention_duration` are always available to
* subscribers. For instance, it allows any attached subscription to [seek to
* a timestamp](https://cloud.google.com/pubsub/docs/replay-
* overview#seek_to_a_time) that is up to `message_retention_duration` in the
* past. If this field is not set, message retention is controlled by settings
* on individual subscriptions. Cannot be more than 31 days or less than 10
* minutes.
*
* @var string
*/
public $messageRetentionDuration;
protected $messageStoragePolicyType = MessageStoragePolicy::class;
protected $messageStoragePolicyDataType = '';
protected $messageTransformsType = MessageTransform::class;
protected $messageTransformsDataType = 'array';
/**
* Required. Identifier. The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
* (`%`). It must be between 3 and 255 characters in length, and it must not
* start with `"goog"`.
*
* @var string
*/
public $name;
/**
* Optional. Reserved for future use. This field is set only in responses from
* the server; it is ignored if it is set in any requests.
*
* @var bool
*/
public $satisfiesPzs;
protected $schemaSettingsType = SchemaSettings::class;
protected $schemaSettingsDataType = '';
/**
* Output only. An output-only field indicating the state of the topic.
*
* @var string
*/
public $state;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @var string[]
*/
public $tags;
/**
* Optional. Settings for ingestion from a data source into this topic.
*
* @param IngestionDataSourceSettings $ingestionDataSourceSettings
*/
public function setIngestionDataSourceSettings(IngestionDataSourceSettings $ingestionDataSourceSettings)
{
$this->ingestionDataSourceSettings = $ingestionDataSourceSettings;
}
/**
* @return IngestionDataSourceSettings
*/
public function getIngestionDataSourceSettings()
{
return $this->ingestionDataSourceSettings;
}
/**
* Optional. The resource name of the Cloud KMS CryptoKey to be used to
* protect access to messages published on this topic. The expected format is
* `projects/locations/keyRings/cryptoKeys`.
*
* @param string $kmsKeyName
*/
public function setKmsKeyName($kmsKeyName)
{
$this->kmsKeyName = $kmsKeyName;
}
/**
* @return string
*/
public function getKmsKeyName()
{
return $this->kmsKeyName;
}
/**
* Optional. See [Creating and managing labels]
* (https://cloud.google.com/pubsub/docs/labels).
*
* @param string[] $labels
*/
public function setLabels($labels)
{
$this->labels = $labels;
}
/**
* @return string[]
*/
public function getLabels()
{
return $this->labels;
}
/**
* Optional. Indicates the minimum duration to retain a message after it is
* published to the topic. If this field is set, messages published to the
* topic in the last `message_retention_duration` are always available to
* subscribers. For instance, it allows any attached subscription to [seek to
* a timestamp](https://cloud.google.com/pubsub/docs/replay-
* overview#seek_to_a_time) that is up to `message_retention_duration` in the
* past. If this field is not set, message retention is controlled by settings
* on individual subscriptions. Cannot be more than 31 days or less than 10
* minutes.
*
* @param string $messageRetentionDuration
*/
public function setMessageRetentionDuration($messageRetentionDuration)
{
$this->messageRetentionDuration = $messageRetentionDuration;
}
/**
* @return string
*/
public function getMessageRetentionDuration()
{
return $this->messageRetentionDuration;
}
/**
* Optional. Policy constraining the set of Google Cloud Platform regions
* where messages published to the topic may be stored. If not present, then
* no constraints are in effect.
*
* @param MessageStoragePolicy $messageStoragePolicy
*/
public function setMessageStoragePolicy(MessageStoragePolicy $messageStoragePolicy)
{
$this->messageStoragePolicy = $messageStoragePolicy;
}
/**
* @return MessageStoragePolicy
*/
public function getMessageStoragePolicy()
{
return $this->messageStoragePolicy;
}
/**
* Optional. Transforms to be applied to messages published to the topic.
* Transforms are applied in the order specified.
*
* @param MessageTransform[] $messageTransforms
*/
public function setMessageTransforms($messageTransforms)
{
$this->messageTransforms = $messageTransforms;
}
/**
* @return MessageTransform[]
*/
public function getMessageTransforms()
{
return $this->messageTransforms;
}
/**
* Required. Identifier. The name of the topic. It must have the format
* `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
* and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),
* underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs
* (`%`). It must be between 3 and 255 characters in length, and it must not
* start with `"goog"`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Optional. Reserved for future use. This field is set only in responses from
* the server; it is ignored if it is set in any requests.
*
* @param bool $satisfiesPzs
*/
public function setSatisfiesPzs($satisfiesPzs)
{
$this->satisfiesPzs = $satisfiesPzs;
}
/**
* @return bool
*/
public function getSatisfiesPzs()
{
return $this->satisfiesPzs;
}
/**
* Optional. Settings for validating messages published against a schema.
*
* @param SchemaSettings $schemaSettings
*/
public function setSchemaSettings(SchemaSettings $schemaSettings)
{
$this->schemaSettings = $schemaSettings;
}
/**
* @return SchemaSettings
*/
public function getSchemaSettings()
{
return $this->schemaSettings;
}
/**
* Output only. An output-only field indicating the state of the topic.
*
* Accepted values: STATE_UNSPECIFIED, ACTIVE, INGESTION_RESOURCE_ERROR
*
* @param self::STATE_* $state
*/
public function setState($state)
{
$this->state = $state;
}
/**
* @return self::STATE_*
*/
public function getState()
{
return $this->state;
}
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this
* resource. For example: "123/environment": "production", "123/costCenter":
* "marketing" See
* https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags
* for more information on using tags with Pub/Sub resources.
*
* @param string[] $tags
*/
public function setTags($tags)
{
$this->tags = $tags;
}
/**
* @return string[]
*/
public function getTags()
{
return $this->tags;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Topic::class, 'Google_Service_Pubsub_Topic');
vendor/google/apiclient-services/src/Pubsub/UnstructuredInference.php
Vendored
+52
View File
@@ -0,0 +1,52 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class UnstructuredInference extends \Google\Model
{
/**
* Optional. A parameters object to be included in each inference request. The
* parameters object is combined with the data field of the Pub/Sub message to
* form the inference request.
*
* @var array[]
*/
public $parameters;
/**
* Optional. A parameters object to be included in each inference request. The
* parameters object is combined with the data field of the Pub/Sub message to
* form the inference request.
*
* @param array[] $parameters
*/
public function setParameters($parameters)
{
$this->parameters = $parameters;
}
/**
* @return array[]
*/
public function getParameters()
{
return $this->parameters;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UnstructuredInference::class, 'Google_Service_Pubsub_UnstructuredInference');
vendor/google/apiclient-services/src/Pubsub/UpdateSnapshotRequest.php
Vendored
+68
View File
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class UpdateSnapshotRequest extends \Google\Model
{
protected $snapshotType = Snapshot::class;
protected $snapshotDataType = '';
/**
* Required. Indicates which fields in the provided snapshot to update. Must
* be specified and non-empty.
*
* @var string
*/
public $updateMask;
/**
* Required. The updated snapshot object.
*
* @param Snapshot $snapshot
*/
public function setSnapshot(Snapshot $snapshot)
{
$this->snapshot = $snapshot;
}
/**
* @return Snapshot
*/
public function getSnapshot()
{
return $this->snapshot;
}
/**
* Required. Indicates which fields in the provided snapshot to update. Must
* be specified and non-empty.
*
* @param string $updateMask
*/
public function setUpdateMask($updateMask)
{
$this->updateMask = $updateMask;
}
/**
* @return string
*/
public function getUpdateMask()
{
return $this->updateMask;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UpdateSnapshotRequest::class, 'Google_Service_Pubsub_UpdateSnapshotRequest');
vendor/google/apiclient-services/src/Pubsub/UpdateSubscriptionRequest.php
Vendored
+68
View File
@@ -0,0 +1,68 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class UpdateSubscriptionRequest extends \Google\Model
{
protected $subscriptionType = Subscription::class;
protected $subscriptionDataType = '';
/**
* Required. Indicates which fields in the provided subscription to update.
* Must be specified and non-empty.
*
* @var string
*/
public $updateMask;
/**
* Required. The updated subscription object.
*
* @param Subscription $subscription
*/
public function setSubscription(Subscription $subscription)
{
$this->subscription = $subscription;
}
/**
* @return Subscription
*/
public function getSubscription()
{
return $this->subscription;
}
/**
* Required. Indicates which fields in the provided subscription to update.
* Must be specified and non-empty.
*
* @param string $updateMask
*/
public function setUpdateMask($updateMask)
{
$this->updateMask = $updateMask;
}
/**
* @return string
*/
public function getUpdateMask()
{
return $this->updateMask;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UpdateSubscriptionRequest::class, 'Google_Service_Pubsub_UpdateSubscriptionRequest');
vendor/google/apiclient-services/src/Pubsub/UpdateTopicRequest.php
Vendored
+74
View File
@@ -0,0 +1,74 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class UpdateTopicRequest extends \Google\Model
{
protected $topicType = Topic::class;
protected $topicDataType = '';
/**
* Required. Indicates which fields in the provided topic to update. Must be
* specified and non-empty. Note that if `update_mask` contains
* "message_storage_policy" but the `message_storage_policy` is not set in the
* `topic` provided above, then the updated value is determined by the policy
* configured at the project or organization level.
*
* @var string
*/
public $updateMask;
/**
* Required. The updated topic object.
*
* @param Topic $topic
*/
public function setTopic(Topic $topic)
{
$this->topic = $topic;
}
/**
* @return Topic
*/
public function getTopic()
{
return $this->topic;
}
/**
* Required. Indicates which fields in the provided topic to update. Must be
* specified and non-empty. Note that if `update_mask` contains
* "message_storage_policy" but the `message_storage_policy` is not set in the
* `topic` provided above, then the updated value is determined by the policy
* configured at the project or organization level.
*
* @param string $updateMask
*/
public function setUpdateMask($updateMask)
{
$this->updateMask = $updateMask;
}
/**
* @return string
*/
public function getUpdateMask()
{
return $this->updateMask;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(UpdateTopicRequest::class, 'Google_Service_Pubsub_UpdateTopicRequest');
vendor/google/apiclient-services/src/Pubsub/ValidateMessageRequest.php
Vendored
+127
View File
@@ -0,0 +1,127 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ValidateMessageRequest extends \Google\Model
{
/**
* Unspecified
*/
public const ENCODING_ENCODING_UNSPECIFIED = 'ENCODING_UNSPECIFIED';
/**
* JSON encoding
*/
public const ENCODING_JSON = 'JSON';
/**
* Binary encoding, as defined by the schema type. For some schema types,
* binary encoding may not be available.
*/
public const ENCODING_BINARY = 'BINARY';
/**
* The encoding expected for messages
*
* @var string
*/
public $encoding;
/**
* Message to validate against the provided `schema_spec`.
*
* @var string
*/
public $message;
/**
* Name of the schema against which to validate. Format is
* `projects/{project}/schemas/{schema}`.
*
* @var string
*/
public $name;
protected $schemaType = Schema::class;
protected $schemaDataType = '';
/**
* The encoding expected for messages
*
* Accepted values: ENCODING_UNSPECIFIED, JSON, BINARY
*
* @param self::ENCODING_* $encoding
*/
public function setEncoding($encoding)
{
$this->encoding = $encoding;
}
/**
* @return self::ENCODING_*
*/
public function getEncoding()
{
return $this->encoding;
}
/**
* Message to validate against the provided `schema_spec`.
*
* @param string $message
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* Name of the schema against which to validate. Format is
* `projects/{project}/schemas/{schema}`.
*
* @param string $name
*/
public function setName($name)
{
$this->name = $name;
}
/**
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Ad-hoc schema against which to validate
*
* @param Schema $schema
*/
public function setSchema(Schema $schema)
{
$this->schema = $schema;
}
/**
* @return Schema
*/
public function getSchema()
{
return $this->schema;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ValidateMessageRequest::class, 'Google_Service_Pubsub_ValidateMessageRequest');
vendor/google/apiclient-services/src/Pubsub/ValidateMessageResponse.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ValidateMessageResponse extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ValidateMessageResponse::class, 'Google_Service_Pubsub_ValidateMessageResponse');
vendor/google/apiclient-services/src/Pubsub/ValidateSchemaRequest.php
Vendored
+44
View File
@@ -0,0 +1,44 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ValidateSchemaRequest extends \Google\Model
{
protected $schemaType = Schema::class;
protected $schemaDataType = '';
/**
* Required. The schema object to validate.
*
* @param Schema $schema
*/
public function setSchema(Schema $schema)
{
$this->schema = $schema;
}
/**
* @return Schema
*/
public function getSchema()
{
return $this->schema;
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ValidateSchemaRequest::class, 'Google_Service_Pubsub_ValidateSchemaRequest');
vendor/google/apiclient-services/src/Pubsub/ValidateSchemaResponse.php
Vendored
+25
View File
@@ -0,0 +1,25 @@
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Pubsub;
class ValidateSchemaResponse extends \Google\Model
{
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(ValidateSchemaResponse::class, 'Google_Service_Pubsub_ValidateSchemaResponse');