cloudprivatecatalog

package
v0.204.0 Latest Latest
Warning

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

Go to latest
Published: Oct 31, 2024 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package cloudprivatecatalog provides access to the Cloud Private Catalog API.

For product documentation, see: https://cloud.google.com/private-catalog/

Creating a client

Usage example:

import "google.golang.org/api/cloudprivatecatalog/v1beta1"
...
ctx := context.Background()
cloudprivatecatalogService, err := cloudprivatecatalog.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

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

cloudprivatecatalogService, err := cloudprivatecatalog.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
cloudprivatecatalogService, err := cloudprivatecatalog.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source
const (
	// View and manage your data across Google Cloud Platform services
	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 FoldersCatalogsSearchCall

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

func (*FoldersCatalogsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersCatalogsSearchCall) Do

Do executes the "cloudprivatecatalog.folders.catalogs.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse.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 (*FoldersCatalogsSearchCall) Fields

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

func (*FoldersCatalogsSearchCall) Header

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

func (*FoldersCatalogsSearchCall) IfNoneMatch

func (c *FoldersCatalogsSearchCall) IfNoneMatch(entityTag string) *FoldersCatalogsSearchCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*FoldersCatalogsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*FoldersCatalogsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.

func (*FoldersCatalogsSearchCall) 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.

func (*FoldersCatalogsSearchCall) Query

Query sets the optional parameter "query": The query to filter the catalogs. The supported queries are:

* Get a single catalog: `name=catalogs/{catalog_id}`

type FoldersCatalogsService

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

func NewFoldersCatalogsService

func NewFoldersCatalogsService(s *Service) *FoldersCatalogsService

func (*FoldersCatalogsService) Search

Search: Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type FoldersProductsSearchCall

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

func (*FoldersProductsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersProductsSearchCall) Do

Do executes the "cloudprivatecatalog.folders.products.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse.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 (*FoldersProductsSearchCall) Fields

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

func (*FoldersProductsSearchCall) Header

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

func (*FoldersProductsSearchCall) IfNoneMatch

func (c *FoldersProductsSearchCall) IfNoneMatch(entityTag string) *FoldersProductsSearchCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*FoldersProductsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*FoldersProductsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.

func (*FoldersProductsSearchCall) 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.

func (*FoldersProductsSearchCall) Query

Query sets the optional parameter "query": The query to filter the products.

The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`

type FoldersProductsService

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

func NewFoldersProductsService

func NewFoldersProductsService(s *Service) *FoldersProductsService

func (*FoldersProductsService) Search

Search: Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type FoldersService

type FoldersService struct {
	Catalogs *FoldersCatalogsService

	Products *FoldersProductsService

	Versions *FoldersVersionsService
	// contains filtered or unexported fields
}

func NewFoldersService

func NewFoldersService(s *Service) *FoldersService

type FoldersVersionsSearchCall

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

func (*FoldersVersionsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*FoldersVersionsSearchCall) Do

Do executes the "cloudprivatecatalog.folders.versions.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse.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 (*FoldersVersionsSearchCall) Fields

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

func (*FoldersVersionsSearchCall) Header

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

func (*FoldersVersionsSearchCall) IfNoneMatch

func (c *FoldersVersionsSearchCall) IfNoneMatch(entityTag string) *FoldersVersionsSearchCall

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*FoldersVersionsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*FoldersVersionsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.

func (*FoldersVersionsSearchCall) 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.

func (*FoldersVersionsSearchCall) Query

Query sets the optional parameter "query": The query to filter the versions. Required.

The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{vers ion_id}`

type FoldersVersionsService

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

func NewFoldersVersionsService

func NewFoldersVersionsService(s *Service) *FoldersVersionsService

func (*FoldersVersionsService) Search

Search: Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type GoogleCloudPrivatecatalogV1beta1Catalog

type GoogleCloudPrivatecatalogV1beta1Catalog struct {
	// CreateTime: Output only. The time when the catalog was created.
	CreateTime string `json:"createTime,omitempty"`

	// Description: Output only. The description of the catalog.
	Description string `json:"description,omitempty"`

	// DisplayName: Output only. The descriptive name of the catalog as it
	// appears in UIs.
	DisplayName string `json:"displayName,omitempty"`

	// Name: Output only. The resource name of the target catalog, in the
	// format of
	// `catalogs/{catalog_id}'.
	Name string `json:"name,omitempty"`

	// UpdateTime: Output only. The time when the catalog was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CreateTime") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateTime") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1Catalog: The readonly representation of a catalog computed with a given resource context.

func (*GoogleCloudPrivatecatalogV1beta1Catalog) MarshalJSON

func (s *GoogleCloudPrivatecatalogV1beta1Catalog) MarshalJSON() ([]byte, error)

type GoogleCloudPrivatecatalogV1beta1Product

type GoogleCloudPrivatecatalogV1beta1Product struct {
	// AssetType: Output only. The type of the product asset. It can be one
	// of the
	// following values:
	//
	// * `google.deploymentmanager.Template`
	// * `google.cloudprivatecatalog.ListingOnly`
	AssetType string `json:"assetType,omitempty"`

	// CreateTime: Output only. The time when the product was created.
	CreateTime string `json:"createTime,omitempty"`

	// DisplayMetadata: Output only. The display metadata to describe the
	// product.
	// The JSON schema of the metadata differs by Product.asset_type.
	// When the type is `google.deploymentmanager.Template`, the schema is
	// as
	// follows:
	//
	// “`
	// "$schema": http://json-schema.org/draft-04/schema#
	// type: object
	// properties:
	//   name:
	//     type: string
	//     minLength: 1
	//     maxLength: 64
	//   description:
	//     type: string
	//     minLength: 1
	//     maxLength: 2048
	//   tagline:
	//     type: string
	//     minLength: 1
	//     maxLength: 100
	//   support_info:
	//     type: string
	//     minLength: 1
	//     maxLength: 2048
	//   creator:
	//     type: string
	//     minLength: 1
	//     maxLength: 100
	//   documentation:
	//     type: array
	//     items:
	//       type: object
	//       properties:
	//         url:
	//           type: string
	//           pattern:
	//
	// "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
	//         title:
	//           type: string
	//           minLength: 1
	//           maxLength: 64
	//         description:
	//           type: string
	//           minLength: 1
	//           maxLength: 2048
	// required:
	// - name
	// - description
	// additionalProperties: false
	//
	// “`
	//
	// When the asset type is `google.cloudprivatecatalog.ListingOnly`, the
	// schema
	// is as follows:
	//
	// “`
	// "$schema": http://json-schema.org/draft-04/schema#
	// type: object
	// properties:
	//   name:
	//     type: string
	//     minLength: 1
	//     maxLength: 64
	//   description:
	//     type: string
	//     minLength: 1
	//     maxLength: 2048
	//   tagline:
	//     type: string
	//     minLength: 1
	//     maxLength: 100
	//   support_info:
	//     type: string
	//     minLength: 1
	//     maxLength: 2048
	//   creator:
	//     type: string
	//     minLength: 1
	//     maxLength: 100
	//   documentation:
	//     type: array
	//     items:
	//       type: object
	//       properties:
	//         url:
	//           type: string
	//           pattern:
	//
	// "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
	//         title:
	//           type: string
	//           minLength: 1
	//           maxLength: 64
	//         description:
	//           type: string
	//           minLength: 1
	//           maxLength: 2048
	//   signup_url:
	//     type: string
	//     pattern:
	//
	// "^(https?)://[-a-zA-Z0-9+&@#/%?=~_|!:,.;]*[-a-zA-Z0-9+&@#/%=~_|]"
	// requ
	// ired:
	// - name
	// - description
	// - signup_url
	// additionalProperties: false
	// “`
	DisplayMetadata googleapi.RawMessage `json:"displayMetadata,omitempty"`

	// IconUri: Output only. The icon URI of the product.
	IconUri string `json:"iconUri,omitempty"`

	// Name: Output only. The resource name of the target product, in the
	// format of
	// `products/a-z*[a-z0-9]'.
	//
	// A unique identifier for the product under a catalog.
	Name string `json:"name,omitempty"`

	// UpdateTime: Output only. The time when the product was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AssetType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AssetType") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1Product: The readonly representation of a product computed with a given resource context.

func (*GoogleCloudPrivatecatalogV1beta1Product) MarshalJSON

func (s *GoogleCloudPrivatecatalogV1beta1Product) MarshalJSON() ([]byte, error)

type GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse

type GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse struct {
	// Catalogs: The `Catalog`s computed from the resource context.
	Catalogs []*GoogleCloudPrivatecatalogV1beta1Catalog `json:"catalogs,omitempty"`

	// NextPageToken: A pagination token returned from a previous call to
	// SearchCatalogs that
	// indicates from where listing should continue.
	// This field is optional.
	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. "Catalogs") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Catalogs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse: Response message for PrivateCatalog.SearchCatalogs.

func (*GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse) MarshalJSON

type GoogleCloudPrivatecatalogV1beta1SearchProductsResponse

type GoogleCloudPrivatecatalogV1beta1SearchProductsResponse struct {
	// NextPageToken: A pagination token returned from a previous call to
	// SearchProducts that
	// indicates from where listing should continue.
	// This field is optional.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Products: The `Product` resources computed from the resource context.
	Products []*GoogleCloudPrivatecatalogV1beta1Product `json:"products,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1SearchProductsResponse: Response message for PrivateCatalog.SearchProducts.

func (*GoogleCloudPrivatecatalogV1beta1SearchProductsResponse) MarshalJSON

type GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse

type GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse struct {
	// NextPageToken: A pagination token returned from a previous call to
	// SearchVersions that
	// indicates from where the listing should continue.
	// This field is optional.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Versions: The `Version` resources computed from the resource context.
	Versions []*GoogleCloudPrivatecatalogV1beta1Version `json:"versions,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NextPageToken") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NextPageToken") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse: Response message for PrivateCatalog.SearchVersions.

func (*GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse) MarshalJSON

type GoogleCloudPrivatecatalogV1beta1Version

type GoogleCloudPrivatecatalogV1beta1Version struct {
	// Asset: Output only. The asset which has been validated and is ready
	// to be
	// provisioned.
	// See
	// google.cloud.privatecatalogproducer.v1beta.Version.asset for details.
	Asset googleapi.RawMessage `json:"asset,omitempty"`

	// CreateTime: Output only. The time when the version was created.
	CreateTime string `json:"createTime,omitempty"`

	// Description: Output only. The user-supplied description of the
	// version. Maximum of 256
	// characters.
	Description string `json:"description,omitempty"`

	// Name: Output only. The resource name of the version, in the
	// format
	// `catalogs/{catalog_id}/products/{product_id}/versions/a-z*[a-z0
	// -9]'.
	//
	// A unique identifier for the version under a product.
	Name string `json:"name,omitempty"`

	// UpdateTime: Output only. The time when the version was last updated.
	UpdateTime string `json:"updateTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Asset") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Asset") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleCloudPrivatecatalogV1beta1Version: The consumer representation of a version which is a child resource under a `Product` with asset data.

func (*GoogleCloudPrivatecatalogV1beta1Version) MarshalJSON

func (s *GoogleCloudPrivatecatalogV1beta1Version) MarshalJSON() ([]byte, error)

type OrganizationsCatalogsSearchCall

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

func (*OrganizationsCatalogsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsCatalogsSearchCall) Do

Do executes the "cloudprivatecatalog.organizations.catalogs.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse.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 (*OrganizationsCatalogsSearchCall) Fields

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

func (*OrganizationsCatalogsSearchCall) Header

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

func (*OrganizationsCatalogsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsCatalogsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*OrganizationsCatalogsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.

func (*OrganizationsCatalogsSearchCall) 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.

func (*OrganizationsCatalogsSearchCall) Query

Query sets the optional parameter "query": The query to filter the catalogs. The supported queries are:

* Get a single catalog: `name=catalogs/{catalog_id}`

type OrganizationsCatalogsService

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

func NewOrganizationsCatalogsService

func NewOrganizationsCatalogsService(s *Service) *OrganizationsCatalogsService

func (*OrganizationsCatalogsService) Search

Search: Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type OrganizationsProductsSearchCall

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

func (*OrganizationsProductsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsProductsSearchCall) Do

Do executes the "cloudprivatecatalog.organizations.products.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse.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 (*OrganizationsProductsSearchCall) Fields

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

func (*OrganizationsProductsSearchCall) Header

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

func (*OrganizationsProductsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsProductsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*OrganizationsProductsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.

func (*OrganizationsProductsSearchCall) 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.

func (*OrganizationsProductsSearchCall) Query

Query sets the optional parameter "query": The query to filter the products.

The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`

type OrganizationsProductsService

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

func NewOrganizationsProductsService

func NewOrganizationsProductsService(s *Service) *OrganizationsProductsService

func (*OrganizationsProductsService) Search

Search: Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type OrganizationsService

type OrganizationsService struct {
	Catalogs *OrganizationsCatalogsService

	Products *OrganizationsProductsService

	Versions *OrganizationsVersionsService
	// contains filtered or unexported fields
}

func NewOrganizationsService

func NewOrganizationsService(s *Service) *OrganizationsService

type OrganizationsVersionsSearchCall

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

func (*OrganizationsVersionsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*OrganizationsVersionsSearchCall) Do

Do executes the "cloudprivatecatalog.organizations.versions.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse.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 (*OrganizationsVersionsSearchCall) Fields

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

func (*OrganizationsVersionsSearchCall) Header

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

func (*OrganizationsVersionsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*OrganizationsVersionsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*OrganizationsVersionsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.

func (*OrganizationsVersionsSearchCall) 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.

func (*OrganizationsVersionsSearchCall) Query

Query sets the optional parameter "query": The query to filter the versions. Required.

The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{vers ion_id}`

type OrganizationsVersionsService

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

func NewOrganizationsVersionsService

func NewOrganizationsVersionsService(s *Service) *OrganizationsVersionsService

func (*OrganizationsVersionsService) Search

Search: Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type ProjectsCatalogsSearchCall

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

func (*ProjectsCatalogsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsCatalogsSearchCall) Do

Do executes the "cloudprivatecatalog.projects.catalogs.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse.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 (*ProjectsCatalogsSearchCall) Fields

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

func (*ProjectsCatalogsSearchCall) Header

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

func (*ProjectsCatalogsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsCatalogsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*ProjectsCatalogsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.

func (*ProjectsCatalogsSearchCall) 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.

func (*ProjectsCatalogsSearchCall) Query

Query sets the optional parameter "query": The query to filter the catalogs. The supported queries are:

* Get a single catalog: `name=catalogs/{catalog_id}`

type ProjectsCatalogsService

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

func NewProjectsCatalogsService

func NewProjectsCatalogsService(s *Service) *ProjectsCatalogsService

func (*ProjectsCatalogsService) Search

Search: Search Catalog resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type ProjectsProductsSearchCall

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

func (*ProjectsProductsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsProductsSearchCall) Do

Do executes the "cloudprivatecatalog.projects.products.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchProductsResponse.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 (*ProjectsProductsSearchCall) Fields

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

func (*ProjectsProductsSearchCall) Header

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

func (*ProjectsProductsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsProductsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*ProjectsProductsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.

func (*ProjectsProductsSearchCall) 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.

func (*ProjectsProductsSearchCall) Query

Query sets the optional parameter "query": The query to filter the products.

The supported queries are: * List products of all catalogs: empty * List products under a catalog: `parent=catalogs/{catalog_id}` * Get a product by name: `name=catalogs/{catalog_id}/products/{product_id}`

type ProjectsProductsService

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

func NewProjectsProductsService

func NewProjectsProductsService(s *Service) *ProjectsProductsService

func (*ProjectsProductsService) Search

Search: Search Product resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type ProjectsService

type ProjectsService struct {
	Catalogs *ProjectsCatalogsService

	Products *ProjectsProductsService

	Versions *ProjectsVersionsService
	// contains filtered or unexported fields
}

func NewProjectsService

func NewProjectsService(s *Service) *ProjectsService

type ProjectsVersionsSearchCall

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

func (*ProjectsVersionsSearchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsVersionsSearchCall) Do

Do executes the "cloudprivatecatalog.projects.versions.search" call. Exactly one of *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse.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 (*ProjectsVersionsSearchCall) Fields

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

func (*ProjectsVersionsSearchCall) Header

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

func (*ProjectsVersionsSearchCall) IfNoneMatch

IfNoneMatch sets the 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. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsVersionsSearchCall) PageSize

PageSize sets the optional parameter "pageSize": The maximum number of entries that are requested.

func (*ProjectsVersionsSearchCall) PageToken

PageToken sets the optional parameter "pageToken": A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.

func (*ProjectsVersionsSearchCall) 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.

func (*ProjectsVersionsSearchCall) Query

Query sets the optional parameter "query": The query to filter the versions. Required.

The supported queries are: * List versions under a product: `parent=catalogs/{catalog_id}/products/{product_id}` * Get a version by name: `name=catalogs/{catalog_id}/products/{product_id}/versions/{vers ion_id}`

type ProjectsVersionsService

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

func NewProjectsVersionsService

func NewProjectsVersionsService(s *Service) *ProjectsVersionsService

func (*ProjectsVersionsService) Search

Search: Search Version resources that consumers have access to, within the scope of the consumer cloud resource hierarchy context.

type Service

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

	Folders *FoldersService

	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 added in v0.3.0

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

NewService creates a new Service.

Jump to

Keyboard shortcuts

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