Package com.ibm.cloud.platform_services.global_catalog.v1

Class GlobalCatalog

  • public class GlobalCatalog
extends com.ibm.cloud.sdk.core.service.BaseService
    The catalog service manages offerings across geographies as the system of record. The catalog supports a RESTful API where users can retrieve information about existing offerings and create, manage, and delete their offerings. Start with the base URL and use the endpoints to retrieve metadata about services in the catalog and manage service visbility. Depending on the kind of object, the metadata can include information about pricing, provisioning, regions, and more. For more information, see the [catalog documentation](https://cloud.ibm.com/docs/overview/catalog.html#global-catalog-overview).
    Version:
    v1

    • Field Detail

      • DEFAULT_SERVICE_NAME

        public static final java.lang.String DEFAULT_SERVICE_NAME
        See Also:
        Constant Field Values

      • DEFAULT_SERVICE_URL

        public static final java.lang.String DEFAULT_SERVICE_URL
        See Also:
        Constant Field Values

    • Constructor Detail

      • GlobalCatalog

        public GlobalCatalog​(java.lang.String serviceName,
                     com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `GlobalCatalog` client. The specified service name and authenticator are used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        authenticator - the Authenticator instance to be configured for this client

    • Method Detail

      • newInstance

        public static GlobalCatalog newInstance()
        Class method which constructs an instance of the `GlobalCatalog` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `GlobalCatalog` client using external configuration

      • newInstance

        public static GlobalCatalog newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `GlobalCatalog` client. The specified service name is used to configure the client instance.
        Parameters:
        serviceName - the service name to be used when configuring the client instance
        Returns:
        an instance of the `GlobalCatalog` client using external configuration

      • listCatalogEntries

        public com.ibm.cloud.sdk.core.http.ServiceCall<EntrySearchResult> listCatalogEntries​(ListCatalogEntriesOptions listCatalogEntriesOptions)
        Returns parent catalog entries. Includes key information, such as ID, name, kind, CRN, tags, and provider. This endpoint is ETag enabled.
        Parameters:
        listCatalogEntriesOptions - the ListCatalogEntriesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type EntrySearchResult

      • listCatalogEntries

        public com.ibm.cloud.sdk.core.http.ServiceCall<EntrySearchResult> listCatalogEntries()
        Returns parent catalog entries. Includes key information, such as ID, name, kind, CRN, tags, and provider. This endpoint is ETag enabled.
        Returns:
        a ServiceCall with a result of type EntrySearchResult

      • createCatalogEntry

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogEntry> createCatalogEntry​(CreateCatalogEntryOptions createCatalogEntryOptions)
        Create a catalog entry. The created catalog entry is restricted by default. You must have an administrator or editor role in the scope of the provided token. This API will return an ETag that can be used for standard ETag processing, except when depth query is used.
        Parameters:
        createCatalogEntryOptions - the CreateCatalogEntryOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogEntry

      • getCatalogEntry

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogEntry> getCatalogEntry​(GetCatalogEntryOptions getCatalogEntryOptions)
        Get a specific catalog object. This endpoint returns a specific catalog entry using the object's unique identifier, for example `/_*service_name*?complete=true`. This endpoint is ETag enabled. This can be used by an unauthenticated user for publicly available services.
        Parameters:
        getCatalogEntryOptions - the GetCatalogEntryOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogEntry

      • updateCatalogEntry

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogEntry> updateCatalogEntry​(UpdateCatalogEntryOptions updateCatalogEntryOptions)
        Update a catalog entry. Update a catalog entry. The visibility of the catalog entry cannot be modified with this endpoint. You must be an administrator or editor in the scope of the provided token. This endpoint is ETag enabled.
        Parameters:
        updateCatalogEntryOptions - the UpdateCatalogEntryOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogEntry

      • deleteCatalogEntry

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteCatalogEntry​(DeleteCatalogEntryOptions deleteCatalogEntryOptions)
        Delete a catalog entry. Delete a catalog entry. This will archive the catalog entry for a minimum of two weeks. While archived, it can be restored using the PUT restore API. After two weeks, it will be deleted and cannot be restored. You must have administrator role in the scope of the provided token to modify it. This endpoint is ETag enabled.
        Parameters:
        deleteCatalogEntryOptions - the DeleteCatalogEntryOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getChildObjects

        public com.ibm.cloud.sdk.core.http.ServiceCall<EntrySearchResult> getChildObjects​(GetChildObjectsOptions getChildObjectsOptions)
        Get child catalog entries of a specific kind. Fetch child catalog entries for a catalog entry with a specific id. This endpoint is ETag enabled. This can be used by an unauthenticated user for publicly available services.
        Parameters:
        getChildObjectsOptions - the GetChildObjectsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type EntrySearchResult

      • restoreCatalogEntry

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> restoreCatalogEntry​(RestoreCatalogEntryOptions restoreCatalogEntryOptions)
        Restore archived catalog entry. Restore an archived catalog entry. You must have an administrator role in the scope of the provided token.
        Parameters:
        restoreCatalogEntryOptions - the RestoreCatalogEntryOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getVisibility

        public com.ibm.cloud.sdk.core.http.ServiceCall<Visibility> getVisibility​(GetVisibilityOptions getVisibilityOptions)
        Get the visibility constraints for an object. This endpoint returns the visibility rules for this object. Overall visibility is determined by the parent objects and any further restrictions on this object. You must have an administrator role in the scope of the provided token. This endpoint is ETag enabled.
        Parameters:
        getVisibilityOptions - the GetVisibilityOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Visibility

      • updateVisibility

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateVisibility​(UpdateVisibilityOptions updateVisibilityOptions)
        Update visibility. Update an Object's Visibility. You must have an administrator role in the scope of the provided token. This endpoint is ETag enabled.
        Parameters:
        updateVisibilityOptions - the UpdateVisibilityOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getPricing

        public com.ibm.cloud.sdk.core.http.ServiceCall<PricingGet> getPricing​(GetPricingOptions getPricingOptions)
        Get the pricing for an object. This endpoint returns the pricing for an object. Static pricing is defined in the catalog. Dynamic pricing is stored in IBM Cloud Pricing Catalog. This can be used by an unauthenticated user for publicly available services.
        Parameters:
        getPricingOptions - the GetPricingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type PricingGet

      • getAuditLogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditSearchResult> getAuditLogs​(GetAuditLogsOptions getAuditLogsOptions)
        Get the audit logs for an object. This endpoint returns the audit logs for an object. Only administrators and editors can get logs.
        Parameters:
        getAuditLogsOptions - the GetAuditLogsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AuditSearchResult

      • listArtifacts

        public com.ibm.cloud.sdk.core.http.ServiceCall<Artifacts> listArtifacts​(ListArtifactsOptions listArtifactsOptions)
        Get artifacts. This endpoint returns a list of artifacts for an object.
        Parameters:
        listArtifactsOptions - the ListArtifactsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Artifacts

      • getArtifact

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getArtifact​(GetArtifactOptions getArtifactOptions)
        Get artifact. This endpoint returns the binary of an artifact.
        Parameters:
        getArtifactOptions - the GetArtifactOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • uploadArtifact

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> uploadArtifact​(UploadArtifactOptions uploadArtifactOptions)
        Upload artifact. This endpoint uploads the binary for an artifact. Only administrators and editors can upload artifacts.
        Parameters:
        uploadArtifactOptions - the UploadArtifactOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • deleteArtifact

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteArtifact​(DeleteArtifactOptions deleteArtifactOptions)
        Delete artifact. This endpoint deletes an artifact. Only administrators and editors can delete artifacts.
        Parameters:
        deleteArtifactOptions - the DeleteArtifactOptions containing the options for the call
        Returns:
        a ServiceCall with a void result