google_api_cloud_private_catalog v0.3.0 GoogleApi.CloudPrivateCatalog.V1beta1.Api.Folders View Source

API calls for all endpoints tagged Folders.

Link to this section Summary

Functions

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

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

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

Link to this section Functions

Link to this function

cloudprivatecatalog_folders_catalogs_search(connection, resource, optional_params \\ [], opts \\ [])

View Source

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

Parameters

  • connection (type: GoogleApi.CloudPrivateCatalog.V1beta1.Connection.t) - Connection to server

  • resource (type: String.t) - Required. The name of the resource context. It can be in following formats:

    • projects/{project_id}
    • folders/{folder_id}
    • organizations/{organization_id}
  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of entries that are requested.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to SearchCatalogs that indicates where this listing should continue from. This field is optional.
    • :query (type: String.t) - The query to filter the catalogs. The supported queries are:

      • Get a single catalog: name=catalogs/{catalog_id}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudPrivateCatalog.V1beta1.Model.GoogleCloudPrivatecatalogV1beta1SearchCatalogsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudprivatecatalog_folders_products_search(connection, resource, optional_params \\ [], opts \\ [])

View Source

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

Parameters

  • connection (type: GoogleApi.CloudPrivateCatalog.V1beta1.Connection.t) - Connection to server

  • resource (type: String.t) - Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of entries that are requested.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to SearchProducts that indicates where this listing should continue from. This field is optional.
    • :query (type: String.t) - 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}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudPrivateCatalog.V1beta1.Model.GoogleCloudPrivatecatalogV1beta1SearchProductsResponse{}} on success
  • {:error, info} on failure
Link to this function

cloudprivatecatalog_folders_versions_search(connection, resource, optional_params \\ [], opts \\ [])

View Source

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

Parameters

  • connection (type: GoogleApi.CloudPrivateCatalog.V1beta1.Connection.t) - Connection to server

  • resource (type: String.t) - Required. The name of the resource context. See SearchCatalogsRequest.resource for details.

  • optional_params (type: keyword()) - Optional parameters

    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of entries that are requested.
    • :pageToken (type: String.t) - A pagination token returned from a previous call to SearchVersions that indicates where this listing should continue from. This field is optional.
    • :query (type: String.t) - 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/{version_id}
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudPrivateCatalog.V1beta1.Model.GoogleCloudPrivatecatalogV1beta1SearchVersionsResponse{}} on success
  • {:error, info} on failure