analyticshub

package
v0.196.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 3, 2024 License: BSD-3-Clause Imports: 16 Imported by: 1

Documentation

Overview

Package analyticshub provides access to the Analytics Hub API.

For product documentation, see: https://cloud.google.com/bigquery/docs/analytics-hub-introduction

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/analyticshub/v1beta1"
...
ctx := context.Background()
analyticshubService, err := analyticshub.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:

analyticshubService, err := analyticshub.NewService(ctx, option.WithScopes(analyticshub.CloudPlatformScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

analyticshubService, err := analyticshub.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, ...)
analyticshubService, err := analyticshub.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source
const (
	// View and manage your data in Google BigQuery and see the email address for
	// your Google Account
	BigqueryScope = "https://www.googleapis.com/auth/bigquery"

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

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AuditConfig

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`
	// Service: Specifies a service that will be enabled for audit logging. For
	// example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices`
	// is a special value that covers all services.
	Service string `json:"service,omitempty"`
	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") 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. "AuditLogConfigs") 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:"-"`
}

AuditConfig: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.

func (AuditConfig) MarshalJSON

func (s AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging for this
	// type of permission. Follows the same format of Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`
	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") 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. "ExemptedMembers") 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:"-"`
}

AuditLogConfig: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

func (AuditLogConfig) MarshalJSON

func (s AuditLogConfig) MarshalJSON() ([]byte, error)

type BigQueryDatasetSource

type BigQueryDatasetSource struct {
	// Dataset: Resource name of the dataset source for this listing. e.g.
	// `projects/myproject/datasets/123`
	Dataset string `json:"dataset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Dataset") 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. "Dataset") 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:"-"`
}

BigQueryDatasetSource: A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.

func (BigQueryDatasetSource) MarshalJSON

func (s BigQueryDatasetSource) MarshalJSON() ([]byte, error)

type Binding

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:"-"`
}

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

func (Binding) MarshalJSON

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

type DataExchange

type DataExchange struct {
	// Description: Optional. Description of the data exchange. The description
	// must not contain Unicode non-characters as well as C0 and C1 control codes
	// except tabs (HT), new lines (LF), carriage returns (CR), and page breaks
	// (FF). Default value is an empty string. Max length: 2000 bytes.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Human-readable display name of the data exchange. The
	// display name must contain only Unicode letters, numbers (0-9), underscores
	// (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with
	// spaces. Default value is an empty string. Max length: 63 bytes.
	DisplayName string `json:"displayName,omitempty"`
	// Documentation: Optional. Documentation describing the data exchange.
	Documentation string `json:"documentation,omitempty"`
	// Icon: Optional. Base64 encoded image representing the data exchange. Max
	// Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API
	// only performs validation on size of the encoded data. Note: For byte fields,
	// the content of the fields are base64-encoded (which increases the size of
	// the data by 33-36%) when using JSON on the wire.
	Icon string `json:"icon,omitempty"`
	// ListingCount: Output only. Number of listings contained in the data
	// exchange.
	ListingCount int64 `json:"listingCount,omitempty"`
	// Name: Output only. The resource name of the data exchange. e.g.
	// `projects/myproject/locations/US/dataExchanges/123`.
	Name string `json:"name,omitempty"`
	// PrimaryContact: Optional. Email or URL of the primary point of contact of
	// the data exchange. Max Length: 1000 bytes.
	PrimaryContact string `json:"primaryContact,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`
}

DataExchange: A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.

func (DataExchange) MarshalJSON

func (s DataExchange) MarshalJSON() ([]byte, error)

type DataProvider

type DataProvider struct {
	// Name: Optional. Name of the data provider.
	Name string `json:"name,omitempty"`
	// PrimaryContact: Optional. Email or URL of the data provider. Max Length:
	// 1000 bytes.
	PrimaryContact string `json:"primaryContact,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`
}

DataProvider: Contains details of the data provider.

func (DataProvider) MarshalJSON

func (s DataProvider) MarshalJSON() ([]byte, error)

type DestinationDataset

type DestinationDataset struct {
	// DatasetReference: Required. A reference that identifies the destination
	// dataset.
	DatasetReference *DestinationDatasetReference `json:"datasetReference,omitempty"`
	// Description: Optional. A user-friendly description of the dataset.
	Description string `json:"description,omitempty"`
	// FriendlyName: Optional. A descriptive name for the dataset.
	FriendlyName string `json:"friendlyName,omitempty"`
	// Labels: Optional. The labels associated with this dataset. You can use these
	// to organize and group your datasets. You can set this property when
	// inserting or updating a dataset. See
	// https://cloud.google.com/resource-manager/docs/creating-managing-labels for
	// more information.
	Labels map[string]string `json:"labels,omitempty"`
	// Location: Required. The geographic location where the dataset should reside.
	// See https://cloud.google.com/bigquery/docs/locations for supported
	// locations.
	Location string `json:"location,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatasetReference") 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. "DatasetReference") 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:"-"`
}

DestinationDataset: Defines the destination bigquery dataset.

func (DestinationDataset) MarshalJSON

func (s DestinationDataset) MarshalJSON() ([]byte, error)

type DestinationDatasetReference

type DestinationDatasetReference struct {
	// DatasetId: Required. A unique ID for this dataset, without the project name.
	// The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores
	// (_). The maximum length is 1,024 characters.
	DatasetId string `json:"datasetId,omitempty"`
	// ProjectId: Required. The ID of the project containing this dataset.
	ProjectId string `json:"projectId,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DatasetId") 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. "DatasetId") 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:"-"`
}

DestinationDatasetReference: Contains the reference that identifies a destination bigquery dataset.

func (DestinationDatasetReference) MarshalJSON

func (s DestinationDatasetReference) MarshalJSON() ([]byte, error)

type Empty

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

type Expr

type Expr struct {
	// Description: Optional. Description of the expression. This is a longer text
	// which describes the expression, e.g. when hovered over it in a UI.
	Description string `json:"description,omitempty"`
	// Expression: Textual representation of an expression in Common Expression
	// Language syntax.
	Expression string `json:"expression,omitempty"`
	// Location: Optional. String indicating the location of the expression for
	// error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`
	// Title: 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.
	Title string `json:"title,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Description") 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. "Description") 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:"-"`
}

Expr: Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

func (Expr) MarshalJSON

func (s Expr) MarshalJSON() ([]byte, error)

type GetIamPolicyRequest

type GetIamPolicyRequest struct {
	// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
	// `GetIamPolicy`.
	Options *GetPolicyOptions `json:"options,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Options") 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. "Options") 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:"-"`
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (GetIamPolicyRequest) MarshalJSON

func (s GetIamPolicyRequest) MarshalJSON() ([]byte, error)

type GetPolicyOptions

type GetPolicyOptions struct {
	// 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).
	RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"`
	// ForceSendFields is a list of field names (e.g. "RequestedPolicyVersion") 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. "RequestedPolicyVersion") 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:"-"`
}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (GetPolicyOptions) MarshalJSON

func (s GetPolicyOptions) MarshalJSON() ([]byte, error)

type LinkedResource added in v0.135.0

type LinkedResource struct {
	// LinkedDataset: Output only. Name of the linked dataset, e.g.
	// projects/subscriberproject/datasets/linked_dataset
	LinkedDataset string `json:"linkedDataset,omitempty"`
	// LinkedPubsubSubscription: Output only. Name of the Pub/Sub subscription,
	// e.g. projects/subscriberproject/subscriptions/subscriptions/sub_id
	LinkedPubsubSubscription string `json:"linkedPubsubSubscription,omitempty"`
	// Listing: Output only. Listing for which linked resource is created.
	Listing string `json:"listing,omitempty"`
	// ForceSendFields is a list of field names (e.g. "LinkedDataset") 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. "LinkedDataset") 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:"-"`
}

LinkedResource: Reference to a linked resource tracked by this Subscription.

func (LinkedResource) MarshalJSON added in v0.135.0

func (s LinkedResource) MarshalJSON() ([]byte, error)

type ListDataExchangesResponse

type ListDataExchangesResponse struct {
	// DataExchanges: The list of data exchanges.
	DataExchanges []*DataExchange `json:"dataExchanges,omitempty"`
	// NextPageToken: A token to request the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DataExchanges") 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. "DataExchanges") 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:"-"`
}

ListDataExchangesResponse: Message for response to the list of data exchanges.

func (ListDataExchangesResponse) MarshalJSON

func (s ListDataExchangesResponse) MarshalJSON() ([]byte, error)

type ListListingsResponse

type ListListingsResponse struct {
	// Listings: The list of Listing.
	Listings []*Listing `json:"listings,omitempty"`
	// NextPageToken: A token to request the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Listings") 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. "Listings") 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:"-"`
}

ListListingsResponse: Message for response to the list of Listings.

func (ListListingsResponse) MarshalJSON

func (s ListListingsResponse) MarshalJSON() ([]byte, error)

type ListOrgDataExchangesResponse

type ListOrgDataExchangesResponse struct {
	// DataExchanges: The list of data exchanges.
	DataExchanges []*DataExchange `json:"dataExchanges,omitempty"`
	// NextPageToken: A token to request the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "DataExchanges") 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. "DataExchanges") 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:"-"`
}

ListOrgDataExchangesResponse: Message for response to listing data exchanges in an organization and location.

func (ListOrgDataExchangesResponse) MarshalJSON

func (s ListOrgDataExchangesResponse) MarshalJSON() ([]byte, error)

type Listing

type Listing struct {
	// BigqueryDataset: Required. Shared dataset i.e. BigQuery dataset source.
	BigqueryDataset *BigQueryDatasetSource `json:"bigqueryDataset,omitempty"`
	// Categories: Optional. Categories of the listing. Up to two categories are
	// allowed.
	//
	// Possible values:
	//   "CATEGORY_UNSPECIFIED"
	//   "CATEGORY_OTHERS"
	//   "CATEGORY_ADVERTISING_AND_MARKETING"
	//   "CATEGORY_COMMERCE"
	//   "CATEGORY_CLIMATE_AND_ENVIRONMENT"
	//   "CATEGORY_DEMOGRAPHICS"
	//   "CATEGORY_ECONOMICS"
	//   "CATEGORY_EDUCATION"
	//   "CATEGORY_ENERGY"
	//   "CATEGORY_FINANCIAL"
	//   "CATEGORY_GAMING"
	//   "CATEGORY_GEOSPATIAL"
	//   "CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE"
	//   "CATEGORY_MEDIA"
	//   "CATEGORY_PUBLIC_SECTOR"
	//   "CATEGORY_RETAIL"
	//   "CATEGORY_SPORTS"
	//   "CATEGORY_SCIENCE_AND_RESEARCH"
	//   "CATEGORY_TRANSPORTATION_AND_LOGISTICS"
	//   "CATEGORY_TRAVEL_AND_TOURISM"
	Categories []string `json:"categories,omitempty"`
	// DataProvider: Optional. Details of the data provider who owns the source
	// data.
	DataProvider *DataProvider `json:"dataProvider,omitempty"`
	// Description: Optional. Short description of the listing. The description
	// must not contain Unicode non-characters and C0 and C1 control codes except
	// tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF).
	// Default value is an empty string. Max length: 2000 bytes.
	Description string `json:"description,omitempty"`
	// DisplayName: Required. Human-readable display name of the listing. The
	// display name must contain only Unicode letters, numbers (0-9), underscores
	// (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with
	// spaces. Default value is an empty string. Max length: 63 bytes.
	DisplayName string `json:"displayName,omitempty"`
	// Documentation: Optional. Documentation describing the listing.
	Documentation string `json:"documentation,omitempty"`
	// Icon: Optional. Base64 encoded image representing the listing. Max Size:
	// 3.0MiB Expected image dimensions are 512x512 pixels, however the API only
	// performs validation on size of the encoded data. Note: For byte fields, the
	// contents of the field are base64-encoded (which increases the size of the
	// data by 33-36%) when using JSON on the wire.
	Icon string `json:"icon,omitempty"`
	// Name: Output only. The resource name of the listing. e.g.
	// `projects/myproject/locations/US/dataExchanges/123/listings/456`
	Name string `json:"name,omitempty"`
	// PrimaryContact: Optional. Email or URL of the primary point of contact of
	// the listing. Max Length: 1000 bytes.
	PrimaryContact string `json:"primaryContact,omitempty"`
	// Publisher: Optional. Details of the publisher who owns the listing and who
	// can share the source data.
	Publisher *Publisher `json:"publisher,omitempty"`
	// RequestAccess: Optional. Email or URL of the request access of the listing.
	// Subscribers can use this reference to request access. Max Length: 1000
	// bytes.
	RequestAccess string `json:"requestAccess,omitempty"`
	// RestrictedExportConfig: Optional. If set, restricted export configuration
	// will be propagated and enforced on the linked dataset. This is a required
	// field for data clean room exchanges.
	RestrictedExportConfig *RestrictedExportConfig `json:"restrictedExportConfig,omitempty"`
	// State: Output only. Current state of the listing.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default value. This value is unused.
	//   "ACTIVE" - Subscribable state. Users with dataexchange.listings.subscribe
	// permission can subscribe to this listing.
	State string `json:"state,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "BigqueryDataset") 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. "BigqueryDataset") 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:"-"`
}

Listing: A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.

func (Listing) MarshalJSON

func (s Listing) MarshalJSON() ([]byte, error)

type OperationMetadata

type OperationMetadata struct {
	// ApiVersion: Output only. API version used to start the operation.
	ApiVersion string `json:"apiVersion,omitempty"`
	// CreateTime: Output only. The time the operation was created.
	CreateTime string `json:"createTime,omitempty"`
	// EndTime: Output only. The time the operation finished running.
	EndTime string `json:"endTime,omitempty"`
	// RequestedCancellation: Output only. Identifies whether the user has
	// requested cancellation of the operation. Operations that have successfully
	// been cancelled have Operation.error value with a google.rpc.Status.code of
	// 1, corresponding to `Code.CANCELLED`.
	RequestedCancellation bool `json:"requestedCancellation,omitempty"`
	// StatusMessage: Output only. Human-readable status of the operation, if any.
	StatusMessage string `json:"statusMessage,omitempty"`
	// Target: Output only. Server-defined resource path for the target of the
	// operation.
	Target string `json:"target,omitempty"`
	// Verb: Output only. Name of the verb executed by the operation.
	Verb string `json:"verb,omitempty"`
	// ForceSendFields is a list of field names (e.g. "ApiVersion") 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. "ApiVersion") 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:"-"`
}

OperationMetadata: Represents the metadata of a long-running operation in Analytics Hub.

func (OperationMetadata) MarshalJSON

func (s OperationMetadata) MarshalJSON() ([]byte, error)

type OrganizationsLocationsDataExchangesListCall

type OrganizationsLocationsDataExchangesListCall struct {
	// contains filtered or unexported fields
}

func (*OrganizationsLocationsDataExchangesListCall) Context

Context sets the context to be used in this call's Do method.

func (*OrganizationsLocationsDataExchangesListCall) Do

Do executes the "analyticshub.organizations.locations.dataExchanges.list" call. Any non-2xx status code is an error. Response headers are in either *ListOrgDataExchangesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*OrganizationsLocationsDataExchangesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*OrganizationsLocationsDataExchangesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*OrganizationsLocationsDataExchangesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*OrganizationsLocationsDataExchangesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

func (*OrganizationsLocationsDataExchangesListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token, returned by a previous call, to request the next page of results.

func (*OrganizationsLocationsDataExchangesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type OrganizationsLocationsDataExchangesService

type OrganizationsLocationsDataExchangesService struct {
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsDataExchangesService

func NewOrganizationsLocationsDataExchangesService(s *Service) *OrganizationsLocationsDataExchangesService

func (*OrganizationsLocationsDataExchangesService) List

List: Lists all data exchanges from projects in a given organization and location.

  • organization: The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.

type OrganizationsLocationsService

type OrganizationsLocationsService struct {
	DataExchanges *OrganizationsLocationsDataExchangesService
	// contains filtered or unexported fields
}

func NewOrganizationsLocationsService

func NewOrganizationsLocationsService(s *Service) *OrganizationsLocationsService

type OrganizationsService

type OrganizationsService struct {
	Locations *OrganizationsLocationsService
	// contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

type Policy

type Policy struct {
	// AuditConfigs: Specifies cloud audit logging configuration for this policy.
	AuditConfigs []*AuditConfig `json:"auditConfigs,omitempty"`
	// Bindings: 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`.
	Bindings []*Binding `json:"bindings,omitempty"`
	// Etag: `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.
	Etag string `json:"etag,omitempty"`
	// Version: 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).
	Version int64 `json:"version,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "AuditConfigs") 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. "AuditConfigs") 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:"-"`
}

Policy: An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

func (Policy) MarshalJSON

func (s Policy) MarshalJSON() ([]byte, error)

type ProjectsLocationsDataExchangesCreateCall

type ProjectsLocationsDataExchangesCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesCreateCall) DataExchangeId

DataExchangeId sets the optional parameter "dataExchangeId": Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.

func (*ProjectsLocationsDataExchangesCreateCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.create" call. Any non-2xx status code is an error. Response headers are in either *DataExchange.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesDeleteCall

type ProjectsLocationsDataExchangesDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesDeleteCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesGetCall

type ProjectsLocationsDataExchangesGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesGetCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.get" call. Any non-2xx status code is an error. Response headers are in either *DataExchange.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDataExchangesGetIamPolicyCall

type ProjectsLocationsDataExchangesGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesGetIamPolicyCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesListCall

type ProjectsLocationsDataExchangesListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.list" call. Any non-2xx status code is an error. Response headers are in either *ListDataExchangesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDataExchangesListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

func (*ProjectsLocationsDataExchangesListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token, returned by a previous call, to request the next page of results.

func (*ProjectsLocationsDataExchangesListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDataExchangesListingsCreateCall

type ProjectsLocationsDataExchangesListingsCreateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsCreateCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsCreateCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.create" call. Any non-2xx status code is an error. Response headers are in either *Listing.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsCreateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsCreateCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesListingsCreateCall) ListingId

ListingId sets the optional parameter "listingId": Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.

type ProjectsLocationsDataExchangesListingsDeleteCall

type ProjectsLocationsDataExchangesListingsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsDeleteCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsDeleteCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.delete" call. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsDeleteCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesListingsGetCall

type ProjectsLocationsDataExchangesListingsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsGetCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsGetCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.get" call. Any non-2xx status code is an error. Response headers are in either *Listing.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsGetCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesListingsGetCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

type ProjectsLocationsDataExchangesListingsGetIamPolicyCall

type ProjectsLocationsDataExchangesListingsGetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsGetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsGetIamPolicyCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.getIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsGetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsGetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesListingsListCall

type ProjectsLocationsDataExchangesListingsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsListCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsListCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.list" call. Any non-2xx status code is an error. Response headers are in either *ListListingsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsListCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesListingsListCall) IfNoneMatch

IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.

func (*ProjectsLocationsDataExchangesListingsListCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

func (*ProjectsLocationsDataExchangesListingsListCall) PageToken

PageToken sets the optional parameter "pageToken": Page token, returned by a previous call, to request the next page of results.

func (*ProjectsLocationsDataExchangesListingsListCall) Pages

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type ProjectsLocationsDataExchangesListingsPatchCall

type ProjectsLocationsDataExchangesListingsPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsPatchCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.patch" call. Any non-2xx status code is an error. Response headers are in either *Listing.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesListingsPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.

type ProjectsLocationsDataExchangesListingsService

type ProjectsLocationsDataExchangesListingsService struct {
	// contains filtered or unexported fields
}

func NewProjectsLocationsDataExchangesListingsService

func NewProjectsLocationsDataExchangesListingsService(s *Service) *ProjectsLocationsDataExchangesListingsService

func (*ProjectsLocationsDataExchangesListingsService) Create

Create: Creates a new listing.

  • parent: The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.

func (*ProjectsLocationsDataExchangesListingsService) Delete

Delete: Deletes a listing.

  • name: Resource name of the listing to delete. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.

func (*ProjectsLocationsDataExchangesListingsService) Get

Get: Gets the details of a listing.

  • name: The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.

func (*ProjectsLocationsDataExchangesListingsService) GetIamPolicy

GetIamPolicy: Gets the IAM policy.

func (*ProjectsLocationsDataExchangesListingsService) List

List: Lists all listings in a given project and location.

  • parent: The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.

func (*ProjectsLocationsDataExchangesListingsService) Patch

Patch: Updates an existing listing.

  • name: Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.

func (*ProjectsLocationsDataExchangesListingsService) SetIamPolicy

SetIamPolicy: Sets the IAM policy.

func (*ProjectsLocationsDataExchangesListingsService) Subscribe

Subscribe: Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

  • name: Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.

func (*ProjectsLocationsDataExchangesListingsService) TestIamPermissions

TestIamPermissions: Returns the permissions that a caller has.

type ProjectsLocationsDataExchangesListingsSetIamPolicyCall

type ProjectsLocationsDataExchangesListingsSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsSetIamPolicyCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesListingsSubscribeCall

type ProjectsLocationsDataExchangesListingsSubscribeCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsSubscribeCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsSubscribeCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.subscribe" call. Any non-2xx status code is an error. Response headers are in either *SubscribeListingResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsSubscribeCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsSubscribeCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesListingsTestIamPermissionsCall

type ProjectsLocationsDataExchangesListingsTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesListingsTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesListingsTestIamPermissionsCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.listings.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesListingsTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesListingsTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesPatchCall

type ProjectsLocationsDataExchangesPatchCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesPatchCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesPatchCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.patch" call. Any non-2xx status code is an error. Response headers are in either *DataExchange.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesPatchCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

func (*ProjectsLocationsDataExchangesPatchCall) UpdateMask

UpdateMask sets the optional parameter "updateMask": Required. Field mask specifies the fields to update in the data exchange resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.

type ProjectsLocationsDataExchangesService

type ProjectsLocationsDataExchangesService struct {
	Listings *ProjectsLocationsDataExchangesListingsService
	// contains filtered or unexported fields
}

func NewProjectsLocationsDataExchangesService

func NewProjectsLocationsDataExchangesService(s *Service) *ProjectsLocationsDataExchangesService

func (*ProjectsLocationsDataExchangesService) Create

Create: Creates a new data exchange.

  • parent: The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.

func (*ProjectsLocationsDataExchangesService) Delete

Delete: Deletes an existing data exchange.

  • name: The full name of the data exchange resource that you want to delete. For example, `projects/myproject/locations/US/dataExchanges/123`.

func (*ProjectsLocationsDataExchangesService) Get

Get: Gets the details of a data exchange.

  • name: The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.

func (*ProjectsLocationsDataExchangesService) GetIamPolicy

GetIamPolicy: Gets the IAM policy.

func (*ProjectsLocationsDataExchangesService) List

List: Lists all data exchanges in a given project and location.

  • parent: The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.

func (*ProjectsLocationsDataExchangesService) Patch

Patch: Updates an existing data exchange.

  • name: Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.

func (*ProjectsLocationsDataExchangesService) SetIamPolicy

SetIamPolicy: Sets the IAM policy.

func (*ProjectsLocationsDataExchangesService) TestIamPermissions

TestIamPermissions: Returns the permissions that a caller has.

type ProjectsLocationsDataExchangesSetIamPolicyCall

type ProjectsLocationsDataExchangesSetIamPolicyCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesSetIamPolicyCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesSetIamPolicyCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.setIamPolicy" call. Any non-2xx status code is an error. Response headers are in either *Policy.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesSetIamPolicyCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesSetIamPolicyCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsDataExchangesTestIamPermissionsCall

type ProjectsLocationsDataExchangesTestIamPermissionsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsLocationsDataExchangesTestIamPermissionsCall) Context

Context sets the context to be used in this call's Do method.

func (*ProjectsLocationsDataExchangesTestIamPermissionsCall) Do

Do executes the "analyticshub.projects.locations.dataExchanges.testIamPermissions" call. Any non-2xx status code is an error. Response headers are in either *TestIamPermissionsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsLocationsDataExchangesTestIamPermissionsCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.

func (*ProjectsLocationsDataExchangesTestIamPermissionsCall) Header

Header returns a http.Header that can be modified by the caller to add headers to the request.

type ProjectsLocationsService

type ProjectsLocationsService struct {
	DataExchanges *ProjectsLocationsDataExchangesService
	// contains filtered or unexported fields
}

func NewProjectsLocationsService

func NewProjectsLocationsService(s *Service) *ProjectsLocationsService

type ProjectsService

type ProjectsService struct {
	Locations *ProjectsLocationsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type Publisher

type Publisher struct {
	// Name: Optional. Name of the listing publisher.
	Name string `json:"name,omitempty"`
	// PrimaryContact: Optional. Email or URL of the listing publisher. Max Length:
	// 1000 bytes.
	PrimaryContact string `json:"primaryContact,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Name") 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. "Name") 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:"-"`
}

Publisher: Contains details of the listing publisher.

func (Publisher) MarshalJSON

func (s Publisher) MarshalJSON() ([]byte, error)

type RefreshSubscriptionResponse added in v0.135.0

type RefreshSubscriptionResponse struct {
	// Subscription: The refreshed subscription resource.
	Subscription *Subscription `json:"subscription,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Subscription") 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. "Subscription") 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:"-"`
}

RefreshSubscriptionResponse: Message for response when you refresh a subscription.

func (RefreshSubscriptionResponse) MarshalJSON added in v0.135.0

func (s RefreshSubscriptionResponse) MarshalJSON() ([]byte, error)

type RestrictedExportConfig added in v0.109.0

type RestrictedExportConfig struct {
	// Enabled: Optional. If true, enable restricted export.
	Enabled bool `json:"enabled,omitempty"`
	// RestrictDirectTableAccess: Output only. If true, restrict direct table
	// access(read api/tabledata.list) on linked table.
	RestrictDirectTableAccess bool `json:"restrictDirectTableAccess,omitempty"`
	// RestrictQueryResult: Optional. If true, restrict export of query result
	// derived from restricted linked dataset table.
	RestrictQueryResult bool `json:"restrictQueryResult,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Enabled") 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. "Enabled") 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:"-"`
}

RestrictedExportConfig: Restricted export config, used to configure restricted export on linked dataset.

func (RestrictedExportConfig) MarshalJSON added in v0.109.0

func (s RestrictedExportConfig) MarshalJSON() ([]byte, error)

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Organizations *OrganizationsService

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated

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

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 NewService

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

NewService creates a new Service.

type SetIamPolicyRequest

type SetIamPolicyRequest struct {
	// Policy: 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.
	Policy *Policy `json:"policy,omitempty"`
	// UpdateMask: OPTIONAL: A FieldMask specifying which fields of the policy to
	// modify. Only the fields in the mask will be modified. If no mask is
	// provided, the following default mask is used: `paths: "bindings, etag"
	UpdateMask string `json:"updateMask,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Policy") 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. "Policy") 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:"-"`
}

SetIamPolicyRequest: Request message for `SetIamPolicy` method.

func (SetIamPolicyRequest) MarshalJSON

func (s SetIamPolicyRequest) MarshalJSON() ([]byte, error)

type SubscribeDataExchangeResponse added in v0.135.0

type SubscribeDataExchangeResponse struct {
	// Subscription: Subscription object created from this subscribe action.
	Subscription *Subscription `json:"subscription,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Subscription") 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. "Subscription") 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:"-"`
}

SubscribeDataExchangeResponse: Message for response when you subscribe to a Data Exchange.

func (SubscribeDataExchangeResponse) MarshalJSON added in v0.135.0

func (s SubscribeDataExchangeResponse) MarshalJSON() ([]byte, error)

type SubscribeListingRequest

type SubscribeListingRequest struct {
	// DestinationDataset: BigQuery destination dataset to create for the
	// subscriber.
	DestinationDataset *DestinationDataset `json:"destinationDataset,omitempty"`
	// ForceSendFields is a list of field names (e.g. "DestinationDataset") 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. "DestinationDataset") 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:"-"`
}

SubscribeListingRequest: Message for subscribing to a listing.

func (SubscribeListingRequest) MarshalJSON

func (s SubscribeListingRequest) MarshalJSON() ([]byte, error)

type SubscribeListingResponse

type SubscribeListingResponse struct {
	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
}

SubscribeListingResponse: Message for response when you subscribe to a listing.

type Subscription added in v0.135.0

type Subscription struct {
	// CreationTime: Output only. Timestamp when the subscription was created.
	CreationTime string `json:"creationTime,omitempty"`
	// DataExchange: Output only. Resource name of the source Data Exchange. e.g.
	// projects/123/locations/US/dataExchanges/456
	DataExchange string `json:"dataExchange,omitempty"`
	// LastModifyTime: Output only. Timestamp when the subscription was last
	// modified.
	LastModifyTime string `json:"lastModifyTime,omitempty"`
	// LinkedDatasetMap: Output only. Map of listing resource names to associated
	// linked resource, e.g.
	// projects/123/locations/US/dataExchanges/456/listings/789 ->
	// projects/123/datasets/my_dataset For listing-level subscriptions, this is a
	// map of size 1. Only contains values if state == STATE_ACTIVE.
	LinkedDatasetMap map[string]LinkedResource `json:"linkedDatasetMap,omitempty"`
	// LinkedResources: Output only. Linked resources created in the subscription.
	// Only contains values if state = STATE_ACTIVE.
	LinkedResources []*LinkedResource `json:"linkedResources,omitempty"`
	// Listing: Output only. Resource name of the source Listing. e.g.
	// projects/123/locations/US/dataExchanges/456/listings/789
	Listing string `json:"listing,omitempty"`
	// Name: Output only. The resource name of the subscription. e.g.
	// `projects/myproject/locations/US/subscriptions/123`.
	Name string `json:"name,omitempty"`
	// OrganizationDisplayName: Output only. Display name of the project of this
	// subscription.
	OrganizationDisplayName string `json:"organizationDisplayName,omitempty"`
	// OrganizationId: Output only. Organization of the project this subscription
	// belongs to.
	OrganizationId string `json:"organizationId,omitempty"`
	// ResourceType: Output only. Listing shared asset type.
	//
	// Possible values:
	//   "SHARED_RESOURCE_TYPE_UNSPECIFIED" - Not specified.
	//   "BIGQUERY_DATASET" - BigQuery Dataset Asset.
	//   "PUBSUB_TOPIC" - Pub/Sub Topic Asset.
	ResourceType string `json:"resourceType,omitempty"`
	// State: Output only. Current state of the subscription.
	//
	// Possible values:
	//   "STATE_UNSPECIFIED" - Default value. This value is unused.
	//   "STATE_ACTIVE" - This subscription is active and the data is accessible.
	//   "STATE_STALE" - The data referenced by this subscription is out of date
	// and should be refreshed. This can happen when a data provider adds or
	// removes datasets.
	//   "STATE_INACTIVE" - This subscription has been cancelled or revoked and the
	// data is no longer accessible.
	State string `json:"state,omitempty"`
	// SubscriberContact: Output only. Email of the subscriber.
	SubscriberContact string `json:"subscriberContact,omitempty"`
	// ForceSendFields is a list of field names (e.g. "CreationTime") 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. "CreationTime") 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:"-"`
}

Subscription: A subscription represents a subscribers' access to a particular set of published data. It contains references to associated listings, data exchanges, and linked datasets.

func (Subscription) MarshalJSON added in v0.135.0

func (s Subscription) MarshalJSON() ([]byte, error)

type TestIamPermissionsRequest

type TestIamPermissionsRequest struct {
	// 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).
	Permissions []string `json:"permissions,omitempty"`
	// ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`
}

TestIamPermissionsRequest: Request message for `TestIamPermissions` method.

func (TestIamPermissionsRequest) MarshalJSON

func (s TestIamPermissionsRequest) MarshalJSON() ([]byte, error)

type TestIamPermissionsResponse

type TestIamPermissionsResponse struct {
	// Permissions: A subset of `TestPermissionsRequest.permissions` that the
	// caller is allowed.
	Permissions []string `json:"permissions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the server.
	googleapi.ServerResponse `json:"-"`
	// ForceSendFields is a list of field names (e.g. "Permissions") 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. "Permissions") 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:"-"`
}

TestIamPermissionsResponse: Response message for `TestIamPermissions` method.

func (TestIamPermissionsResponse) MarshalJSON

func (s TestIamPermissionsResponse) MarshalJSON() ([]byte, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL