// Copyright 2026 Google LLC.

// Use of this source code is governed by a BSD-style

// license that can be found in the LICENSE file.

// Code generated file. DO NOT EDIT.

// Package pubsub provides access to the Cloud Pub/Sub API.

//

// This package is DEPRECATED. Use package cloud.google.com/go/pubsub instead.

//

// For product documentation, see: https://cloud.google.com/pubsub/docs

//

// # Library status

//

// These client libraries are officially supported by Google. However, this

// library is considered complete and is in maintenance mode. This means

// that we will address critical bugs and security issues but will not add

// any new features.

//

// When possible, we recommend using our newer

// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)

// that are still actively being worked and iterated on.

//

// # Creating a client

//

// Usage example:

//

// import "google.golang.org/api/pubsub/v1"

// ...

// ctx := context.Background()

// pubsubService, err := pubsub.NewService(ctx)

//

// In this example, Google Application Default Credentials are used for

// authentication. For information on how to create and obtain Application

// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

//

// # Other authentication options

//

// By default, all available scopes (see "Constants") are used to authenticate.

// To restrict scopes, use [google.golang.org/api/option.WithScopes]:

//

// pubsubService, err := pubsub.NewService(ctx, option.WithScopes(pubsub.PubsubScope))

//

// To use an API key for authentication (note: some APIs do not support API

// keys), use [google.golang.org/api/option.WithAPIKey]:

//

// pubsubService, err := pubsub.NewService(ctx, option.WithAPIKey("AIza..."))

//

// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth

// flow, use [google.golang.org/api/option.WithTokenSource]:

//

// config := &oauth2.Config{...}

// // ...

// token, err := config.Exchange(ctx, ...)

// pubsubService, err := pubsub.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

//

// See [google.golang.org/api/option.ClientOption] for details on options.

package pubsub // import "google.golang.org/api/pubsub/v1"

import (

"bytes"

"context"

"encoding/json"

"errors"

"fmt"

"io"

"log/slog"

"net/http"

"net/url"

"strconv"

"strings"

"github.com/googleapis/gax-go/v2/internallog"

googleapi "google.golang.org/api/googleapi"

internal "google.golang.org/api/internal"

gensupport "google.golang.org/api/internal/gensupport"

option "google.golang.org/api/option"

internaloption "google.golang.org/api/option/internaloption"

htransport "google.golang.org/api/transport/http"

)

// Always reference these packages, just in case the auto-generated code

// below doesn't.

var _ = bytes.NewBuffer

var _ = strconv.Itoa

var _ = fmt.Sprintf

var _ = json.NewDecoder

var _ = io.Copy

var _ = url.Parse

var _ = gensupport.MarshalJSON

var _ = googleapi.Version

var _ = errors.New

var _ = strings.Replace

var _ = context.Canceled

var _ = internaloption.WithDefaultEndpoint

var _ = internal.Version

var _ = internallog.New

const apiId = "pubsub:v1"

const apiName = "pubsub"

const apiVersion = "v1"

const basePath = "https://pubsub.googleapis.com/"

const basePathTemplate = "https://pubsub.UNIVERSE_DOMAIN/"

const mtlsBasePath = "https://pubsub.mtls.googleapis.com/"

// OAuth2 scopes used by this API.

const (

// See, edit, configure, and delete your Google Cloud data and see the email

// address for your Google Account.

CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

// View and manage Pub/Sub topics and subscriptions

PubsubScope = "https://www.googleapis.com/auth/pubsub"

)

// NewService creates a new Service.

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {

scopesOption := internaloption.WithDefaultScopes(

"https://www.googleapis.com/auth/cloud-platform",

"https://www.googleapis.com/auth/pubsub",

)

// NOTE: prepend, so we don't override user-specified scopes.

opts = append([]option.ClientOption{scopesOption}, opts...)

opts = append(opts, internaloption.WithDefaultEndpoint(basePath))

opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))

opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))

opts = append(opts, internaloption.EnableNewAuthLibrary())

client, endpoint, err := htransport.NewClient(ctx, opts...)

if err != nil {

return nil, err

}

s := &Service{client: client, BasePath: basePath, logger: internaloption.GetLogger(opts)}

s.Projects = NewProjectsService(s)

if endpoint != "" {

s.BasePath = endpoint

}

return s, nil

}

// New creates a new Service. It uses the provided http.Client for requests.

//

// Deprecated: please use NewService instead.

// To provide a custom HTTP client, use option.WithHTTPClient.

// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func New(client *http.Client) (*Service, error) {

if client == nil {

return nil, errors.New("client is nil")

}

return NewService(context.TODO(), option.WithHTTPClient(client))

}

type Service struct {

client *http.Client

logger *slog.Logger

BasePath string // API endpoint base URL

UserAgent string // optional additional User-Agent fragment

Projects *ProjectsService

}

func (s *Service) userAgent() string {

if s.UserAgent == "" {

return googleapi.UserAgent

}

return googleapi.UserAgent + " " + s.UserAgent

}

func NewProjectsService(s *Service) *ProjectsService {

rs := &ProjectsService{s: s}

rs.Schemas = NewProjectsSchemasService(s)

rs.Snapshots = NewProjectsSnapshotsService(s)

rs.Subscriptions = NewProjectsSubscriptionsService(s)

rs.Topics = NewProjectsTopicsService(s)

return rs

}

type ProjectsService struct {

s *Service

Schemas *ProjectsSchemasService

Snapshots *ProjectsSnapshotsService

Subscriptions *ProjectsSubscriptionsService

Topics *ProjectsTopicsService

}

func NewProjectsSchemasService(s *Service) *ProjectsSchemasService {

rs := &ProjectsSchemasService{s: s}

return rs

}

type ProjectsSchemasService struct {

s *Service

}

func NewProjectsSnapshotsService(s *Service) *ProjectsSnapshotsService {

rs := &ProjectsSnapshotsService{s: s}

return rs

}

type ProjectsSnapshotsService struct {

s *Service

}

func NewProjectsSubscriptionsService(s *Service) *ProjectsSubscriptionsService {

rs := &ProjectsSubscriptionsService{s: s}

return rs

}

type ProjectsSubscriptionsService struct {

s *Service

}

func NewProjectsTopicsService(s *Service) *ProjectsTopicsService {

rs := &ProjectsTopicsService{s: s}

rs.Snapshots = NewProjectsTopicsSnapshotsService(s)

rs.Subscriptions = NewProjectsTopicsSubscriptionsService(s)

return rs

}

type ProjectsTopicsService struct {

s *Service

Snapshots *ProjectsTopicsSnapshotsService

Subscriptions *ProjectsTopicsSubscriptionsService

}

func NewProjectsTopicsSnapshotsService(s *Service) *ProjectsTopicsSnapshotsService {

rs := &ProjectsTopicsSnapshotsService{s: s}

return rs

}

type ProjectsTopicsSnapshotsService struct {

s *Service

}

func NewProjectsTopicsSubscriptionsService(s *Service) *ProjectsTopicsSubscriptionsService {

rs := &ProjectsTopicsSubscriptionsService{s: s}

return rs

}

type ProjectsTopicsSubscriptionsService struct {

s *Service

}

// AIInference: Configuration for making inference requests against Vertex AI

// models.

type AIInference struct {

// Endpoint: 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.

Endpoint string `json:"endpoint,omitempty"`

// ServiceAccountEmail: 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.

ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`

// UnstructuredInference: Optional. Requests and responses can be any arbitrary

// JSON object.

UnstructuredInference *UnstructuredInference `json:"unstructuredInference,omitempty"`

// ForceSendFields is a list of field names (e.g. "Endpoint") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "Endpoint") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AIInference) MarshalJSON() ([]byte, error) {

type NoMethod AIInference

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AcknowledgeRequest: Request for the Acknowledge method.

type AcknowledgeRequest struct {

// 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.

AckIds []string `json:"ackIds,omitempty"`

// ForceSendFields is a list of field names (e.g. "AckIds") to unconditionally

// include in API requests. By default, fields with empty or default values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AckIds") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AcknowledgeRequest) MarshalJSON() ([]byte, error) {

type NoMethod AcknowledgeRequest

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AnalyticsHubSubscriptionInfo: Information about an associated Analytics Hub

// subscription

// (https://cloud.google.com/bigquery/docs/analytics-hub-manage-subscriptions).

type AnalyticsHubSubscriptionInfo struct {

// Listing: Optional. The name of the associated Analytics Hub listing

// resource. Pattern:

// "projects/{project}/locations/{location}/dataExchanges/{data_exchange}/listin

// gs/{listing}"

Listing string `json:"listing,omitempty"`

// Subscription: Optional. The name of the associated Analytics Hub

// subscription resource. Pattern:

// "projects/{project}/locations/{location}/subscriptions/{subscription}"

Subscription string `json:"subscription,omitempty"`

// ForceSendFields is a list of field names (e.g. "Listing") to unconditionally

// include in API requests. By default, fields with empty or default values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "Listing") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AnalyticsHubSubscriptionInfo) MarshalJSON() ([]byte, error) {

type NoMethod AnalyticsHubSubscriptionInfo

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AvroConfig: Configuration for writing message data in Avro format. Message

// payloads and metadata will be written to files as an Avro binary.

type AvroConfig struct {

// UseTopicSchema: Optional. When true, the output Cloud Storage file will be

// serialized using the topic schema, if it exists.

UseTopicSchema bool `json:"useTopicSchema,omitempty"`

// WriteMetadata: 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.

WriteMetadata bool `json:"writeMetadata,omitempty"`

// ForceSendFields is a list of field names (e.g. "UseTopicSchema") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "UseTopicSchema") to include in

// API requests with the JSON null value. By default, fields with empty values

// are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AvroConfig) MarshalJSON() ([]byte, error) {

type NoMethod AvroConfig

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AvroFormat: Configuration for reading Cloud Storage data in Avro binary

// format. The bytes of each object will be set to the `data` field of a

// Pub/Sub message.

type AvroFormat struct {

}

// AwsKinesis: Ingestion settings for Amazon Kinesis Data Streams.

type AwsKinesis struct {

// AwsRoleArn: 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.

AwsRoleArn string `json:"awsRoleArn,omitempty"`

// ConsumerArn: 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.

ConsumerArn string `json:"consumerArn,omitempty"`

// GcpServiceAccount: 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.

GcpServiceAccount string `json:"gcpServiceAccount,omitempty"`

// State: Output only. An output-only field that indicates the state of the

// Kinesis ingestion source.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - Ingestion is active.

// "KINESIS_PERMISSION_DENIED" - 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`.

// "PUBLISH_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.publi

// sher)

// "STREAM_NOT_FOUND" - The Kinesis stream does not exist.

// "CONSUMER_NOT_FOUND" - The Kinesis consumer does not exist.

// "CONFLICTING_REGION_CONSTRAINTS" - Indicates an error state where the

// ingestion source cannot be processed. This occurs because there is no

// overlap between the regions allowed by the topic's `MessageStoragePolicy`

// and the regions permitted by the Regional Access Boundary (RAB) restrictions

// on the project's Pub/Sub service account. A common, allowed region is

// required to determine a valid ingestion region.

State string `json:"state,omitempty"`

// StreamArn: Required. The Kinesis stream ARN to ingest data from.

StreamArn string `json:"streamArn,omitempty"`

// ForceSendFields is a list of field names (e.g. "AwsRoleArn") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AwsRoleArn") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AwsKinesis) MarshalJSON() ([]byte, error) {

type NoMethod AwsKinesis

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AwsMsk: Ingestion settings for Amazon MSK.

type AwsMsk struct {

// AwsRoleArn: 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.

AwsRoleArn string `json:"awsRoleArn,omitempty"`

// ClusterArn: Required. The Amazon Resource Name (ARN) that uniquely

// identifies the cluster.

ClusterArn string `json:"clusterArn,omitempty"`

// GcpServiceAccount: 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.

GcpServiceAccount string `json:"gcpServiceAccount,omitempty"`

// State: Output only. An output-only field that indicates the state of the

// Amazon MSK ingestion source.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - Ingestion is active.

// "MSK_PERMISSION_DENIED" - Permission denied encountered while consuming

// data from Amazon MSK.

// "PUBLISH_PERMISSION_DENIED" - Permission denied encountered while

// publishing to the topic.

// "CLUSTER_NOT_FOUND" - The provided MSK cluster wasn't found.

// "TOPIC_NOT_FOUND" - The provided topic wasn't found.

// "CONFLICTING_REGION_CONSTRAINTS" - Indicates an error state where the

// ingestion source cannot be processed. This occurs because there is no

// overlap between the regions allowed by the topic's `MessageStoragePolicy`

// and the regions permitted by the Regional Access Boundary (RAB) restrictions

// on the project's Pub/Sub service account. A common, allowed region is

// required to determine a valid ingestion region.

State string `json:"state,omitempty"`

// Topic: Required. The name of the topic in the Amazon MSK cluster that

// Pub/Sub will import from.

Topic string `json:"topic,omitempty"`

// ForceSendFields is a list of field names (e.g. "AwsRoleArn") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AwsRoleArn") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AwsMsk) MarshalJSON() ([]byte, error) {

type NoMethod AwsMsk

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// AzureEventHubs: Ingestion settings for Azure Event Hubs.

type AzureEventHubs struct {

// ClientId: Optional. The client id of the Azure application that is being

// used to authenticate Pub/Sub.

ClientId string `json:"clientId,omitempty"`

// EventHub: Optional. The name of the Event Hub.

EventHub string `json:"eventHub,omitempty"`

// GcpServiceAccount: Optional. The GCP service account to be used for

// Federated Identity authentication.

GcpServiceAccount string `json:"gcpServiceAccount,omitempty"`

// Namespace: Optional. The name of the Event Hubs namespace.

Namespace string `json:"namespace,omitempty"`

// ResourceGroup: Optional. Name of the resource group within the azure

// subscription.

ResourceGroup string `json:"resourceGroup,omitempty"`

// State: Output only. An output-only field that indicates the state of the

// Event Hubs ingestion source.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - Ingestion is active.

// "EVENT_HUBS_PERMISSION_DENIED" - 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.

// "PUBLISH_PERMISSION_DENIED" - Permission denied encountered while

// publishing to the topic.

// "NAMESPACE_NOT_FOUND" - The provided Event Hubs namespace couldn't be

// found.

// "EVENT_HUB_NOT_FOUND" - The provided Event Hub couldn't be found.

// "SUBSCRIPTION_NOT_FOUND" - The provided Event Hubs subscription couldn't

// be found.

// "RESOURCE_GROUP_NOT_FOUND" - The provided Event Hubs resource group

// couldn't be found.

// "CONFLICTING_REGION_CONSTRAINTS" - Indicates an error state where the

// ingestion source cannot be processed. This occurs because there is no

// overlap between the regions allowed by the topic's `MessageStoragePolicy`

// and the regions permitted by the Regional Access Boundary (RAB) restrictions

// on the project's Pub/Sub service account. A common, allowed region is

// required to determine a valid ingestion region.

State string `json:"state,omitempty"`

// SubscriptionId: Optional. The Azure subscription id.

SubscriptionId string `json:"subscriptionId,omitempty"`

// TenantId: Optional. The tenant id of the Azure application that is being

// used to authenticate Pub/Sub.

TenantId string `json:"tenantId,omitempty"`

// ForceSendFields is a list of field names (e.g. "ClientId") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "ClientId") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s AzureEventHubs) MarshalJSON() ([]byte, error) {

type NoMethod AzureEventHubs

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// BigQueryConfig: Configuration for a BigQuery subscription.

type BigQueryConfig struct {

// DropUnknownFields: 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.

DropUnknownFields bool `json:"dropUnknownFields,omitempty"`

// ServiceAccountEmail: 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.

ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`

// State: Output only. An output-only field that indicates whether or not the

// subscription can receive messages.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - The subscription can actively send messages to BigQuery

// "PERMISSION_DENIED" - 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))

// "NOT_FOUND" - Cannot write to the BigQuery table because it does not

// exist.

// "SCHEMA_MISMATCH" - Cannot write to the BigQuery table due to a schema

// mismatch.

// "IN_TRANSIT_LOCATION_RESTRICTION" - Cannot write to the destination

// because enforce_in_transit is set to true and the destination locations are

// not in the allowed regions.

// "VERTEX_AI_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.

State string `json:"state,omitempty"`

// Table: Optional. The name of the table to which to write data, of the form

// {projectId}.{datasetId}.{tableId}

Table string `json:"table,omitempty"`

// UseTableSchema: 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.

UseTableSchema bool `json:"useTableSchema,omitempty"`

// UseTopicSchema: 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.

UseTopicSchema bool `json:"useTopicSchema,omitempty"`

// WriteMetadata: 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.

WriteMetadata bool `json:"writeMetadata,omitempty"`

// ForceSendFields is a list of field names (e.g. "DropUnknownFields") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "DropUnknownFields") to include in

// API requests with the JSON null value. By default, fields with empty values

// are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s BigQueryConfig) MarshalJSON() ([]byte, error) {

type NoMethod BigQueryConfig

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// BigtableConfig: Configuration for a Bigtable subscription. The Pub/Sub

// message will be written to a Bigtable row as follows: - row key:

// subscription name and message ID delimited by #. - columns: message bytes

// written to a single column family "data" with an empty-string column

// qualifier. - cell timestamp: the message publish timestamp.

type BigtableConfig struct {

// AppProfileId: 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.

AppProfileId string `json:"appProfileId,omitempty"`

// ServiceAccountEmail: 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.

ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`

// State: Output only. An output-only field that indicates whether or not the

// subscription can receive messages.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - The subscription can actively send messages to Bigtable.

// "NOT_FOUND" - Cannot write to Bigtable because the instance, table, or app

// profile does not exist.

// "APP_PROFILE_MISCONFIGURED" - Cannot write to Bigtable because the app

// profile is not configured for single-cluster routing.

// "PERMISSION_DENIED" - Cannot write to Bigtable because of permission

// denied errors. This can happen if: - The Pub/Sub service agent has not been

// granted the [appropriate Bigtable IAM permission

// bigtable.tables.mutateRows]({$universe.dns_names.final_documentation_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-usag

// e/docs/enable-disable))

// "SCHEMA_MISMATCH" - 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.

// "IN_TRANSIT_LOCATION_RESTRICTION" - Cannot write to the destination

// because enforce_in_transit is set to true and the destination locations are

// not in the allowed regions.

// "VERTEX_AI_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.

State string `json:"state,omitempty"`

// Table: Optional. The unique name of the table to write messages to. Values

// are of the form `projects//instances//tables/`.

Table string `json:"table,omitempty"`

// WriteMetadata: 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.

WriteMetadata bool `json:"writeMetadata,omitempty"`

// ForceSendFields is a list of field names (e.g. "AppProfileId") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AppProfileId") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s BigtableConfig) MarshalJSON() ([]byte, error) {

type NoMethod BigtableConfig

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// Binding: Associates `members`, or principals, with a `role`.

type Binding struct {

// Condition: 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).

Condition *Expr `json:"condition,omitempty"`

// Members: 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/locations/global/workforcePools/{pool_id}/sub

// ject/{subject_attribute_value}`: A single identity in a workforce identity

// pool. *

// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/

// group/{group_id}`: All workforce identities in a group. *

// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/

// attribute.{attribute_name}/{attribute_value}`: All workforce identities with

// a specific attribute value. *

// `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/

// *`: All identities in a workforce identity pool. *

// `principal://iam.googleapis.com/projects/{project_number}/locations/global/wo

// rkloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single

// identity in a workload identity pool. *

// `principalSet://iam.googleapis.com/projects/{project_number}/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}/attribute.{attribute_name}/{attribute_value}

// `: All identities in a workload identity pool with a certain attribute. *

// `principalSet://iam.googleapis.com/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-po

// ol-id/subject/my-subject-attribute-value`.

Members []string `json:"members,omitempty"`

// Role: 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).

Role string `json:"role,omitempty"`

// ForceSendFields is a list of field names (e.g. "Condition") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "Condition") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s Binding) MarshalJSON() ([]byte, error) {

type NoMethod Binding

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// CloudStorage: Ingestion settings for Cloud Storage.

type CloudStorage struct {

// AvroFormat: Optional. Data from Cloud Storage will be interpreted in Avro

// format.

AvroFormat *AvroFormat `json:"avroFormat,omitempty"`

// Bucket: 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).

Bucket string `json:"bucket,omitempty"`

// MatchGlob: Optional. Glob pattern used to match objects that will be

// ingested. If unset, all objects will be ingested. See the supported patterns

// (https://cloud.google.com/storage/docs/json_api/v1/objects/list#list-objects-and-prefixes-using-glob).

MatchGlob string `json:"matchGlob,omitempty"`

// MinimumObjectCreateTime: Optional. Only objects with a larger or equal

// creation timestamp will be ingested.

MinimumObjectCreateTime string `json:"minimumObjectCreateTime,omitempty"`

// PubsubAvroFormat: Optional. It will be assumed data from Cloud Storage was

// written via Cloud Storage subscriptions

// (https://cloud.google.com/pubsub/docs/cloudstorage).

PubsubAvroFormat *PubSubAvroFormat `json:"pubsubAvroFormat,omitempty"`

// State: Output only. An output-only field that indicates the state of the

// Cloud Storage ingestion source.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - Ingestion is active.

// "CLOUD_STORAGE_PERMISSION_DENIED" - 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-permiss

// ions): - 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.

// "PUBLISH_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.publi

// sher)

// "BUCKET_NOT_FOUND" - The provided Cloud Storage bucket doesn't exist.

// "TOO_MANY_OBJECTS" - The Cloud Storage bucket has too many objects,

// ingestion will be paused.

// "CONFLICTING_REGION_CONSTRAINTS" - Indicates an error state where the

// ingestion source cannot be processed. This occurs because there is no

// overlap between the regions allowed by the topic's `MessageStoragePolicy`

// and the regions permitted by the Regional Access Boundary (RAB) restrictions

// on the project's Pub/Sub service account. A common, allowed region is

// required to determine a valid ingestion region.

State string `json:"state,omitempty"`

// TextFormat: Optional. Data from Cloud Storage will be interpreted as text.

TextFormat *TextFormat `json:"textFormat,omitempty"`

// ForceSendFields is a list of field names (e.g. "AvroFormat") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AvroFormat") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s CloudStorage) MarshalJSON() ([]byte, error) {

type NoMethod CloudStorage

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// CloudStorageConfig: Configuration for a Cloud Storage subscription.

type CloudStorageConfig struct {

// AvroConfig: Optional. If set, message data will be written to Cloud Storage

// in Avro format.

AvroConfig *AvroConfig `json:"avroConfig,omitempty"`

// Bucket: 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).

Bucket string `json:"bucket,omitempty"`

// FilenameDatetimeFormat: 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).

FilenameDatetimeFormat string `json:"filenameDatetimeFormat,omitempty"`

// FilenamePrefix: Optional. User-provided prefix for Cloud Storage filename.

// See the object naming requirements

// (https://cloud.google.com/storage/docs/objects#naming).

FilenamePrefix string `json:"filenamePrefix,omitempty"`

// FilenameSuffix: 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 "/".

FilenameSuffix string `json:"filenameSuffix,omitempty"`

// MaxBytes: 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.

MaxBytes int64 `json:"maxBytes,omitempty,string"`

// MaxDuration: 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.

MaxDuration string `json:"maxDuration,omitempty"`

// MaxMessages: Optional. The maximum number of messages that can be written to

// a Cloud Storage file before a new file is created. Min 1000 messages.

MaxMessages int64 `json:"maxMessages,omitempty,string"`

// ServiceAccountEmail: 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.

ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"`

// State: Output only. An output-only field that indicates whether or not the

// subscription can receive messages.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - The subscription can actively send messages to Cloud Storage.

// "PERMISSION_DENIED" - Cannot write to the Cloud Storage bucket because of

// permission denied errors.

// "NOT_FOUND" - Cannot write to the Cloud Storage bucket because it does not

// exist.

// "IN_TRANSIT_LOCATION_RESTRICTION" - Cannot write to the destination

// because enforce_in_transit is set to true and the destination locations are

// not in the allowed regions.

// "SCHEMA_MISMATCH" - Cannot write to the Cloud Storage bucket due to an

// incompatibility between the topic schema and subscription settings.

// "VERTEX_AI_LOCATION_RESTRICTION" - 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.

State string `json:"state,omitempty"`

// TextConfig: Optional. If set, message data will be written to Cloud Storage

// in text format.

TextConfig *TextConfig `json:"textConfig,omitempty"`

// ForceSendFields is a list of field names (e.g. "AvroConfig") to

// unconditionally include in API requests. By default, fields with empty or

// default values are omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "AvroConfig") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s CloudStorageConfig) MarshalJSON() ([]byte, error) {

type NoMethod CloudStorageConfig

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// CommitSchemaRequest: Request for CommitSchema method.

type CommitSchemaRequest struct {

// Schema: Required. The schema revision to commit.

Schema *Schema `json:"schema,omitempty"`

// ForceSendFields is a list of field names (e.g. "Schema") to unconditionally

// include in API requests. By default, fields with empty or default values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more

// details.

ForceSendFields []string `json:"-"`

// NullFields is a list of field names (e.g. "Schema") to include in API

// requests with the JSON null value. By default, fields with empty values are

// omitted from API requests. See

// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.

NullFields []string `json:"-"`

}

func (s CommitSchemaRequest) MarshalJSON() ([]byte, error) {

type NoMethod CommitSchemaRequest

return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)

}

// ConfluentCloud: Ingestion settings for Confluent Cloud.

type ConfluentCloud struct {

// BootstrapServer: Required. The address of the bootstrap server. The format

// is url:port.

BootstrapServer string `json:"bootstrapServer,omitempty"`

// ClusterId: Required. The id of the cluster.

ClusterId string `json:"clusterId,omitempty"`

// GcpServiceAccount: Required. The GCP service account to be used for

// Federated Identity authentication with `identity_pool_id`.

GcpServiceAccount string `json:"gcpServiceAccount,omitempty"`

// IdentityPoolId: 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.

IdentityPoolId string `json:"identityPoolId,omitempty"`

// State: Output only. An output-only field that indicates the state of the

// Confluent Cloud ingestion source.

//

// Possible values:

// "STATE_UNSPECIFIED" - Default value. This value is unused.

// "ACTIVE" - Ingestion is active.

// "CONFLUENT_CLOUD_PERMISSION_DENIED" - Permission denied encountered while

// consuming data from Confluent Cloud.

// "PUBLISH_PERMISSION_DENIED" - Permission denied encountered while

// publishing to the topic.

// "UNREACHABLE_BOOTSTRAP_SERVER" - The provided bootstrap server address is

// unreachable.

// "CLUSTER_NOT_FOUND" - The provided cluster wasn't found.