Package com.ibm.cloud.platform_services.catalog_management.v1

Class CatalogManagement

  • public class CatalogManagement
extends com.ibm.cloud.sdk.core.service.BaseService
    This is the API to use for managing private catalogs for IBM Cloud. Private catalogs provide a way to centrally manage access to products in the IBM Cloud catalog and your own catalogs. API Version: 1.0

    • 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

      • CatalogManagement

        public CatalogManagement​(java.lang.String serviceName,
                         com.ibm.cloud.sdk.core.security.Authenticator authenticator)
        Constructs an instance of the `CatalogManagement` 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 CatalogManagement newInstance()
        Class method which constructs an instance of the `CatalogManagement` client. The default service name is used to configure the client instance.
        Returns:
        an instance of the `CatalogManagement` client using external configuration

      • newInstance

        public static CatalogManagement newInstance​(java.lang.String serviceName)
        Class method which constructs an instance of the `CatalogManagement` 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 `CatalogManagement` client using external configuration

      • getCatalogAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<Account> getCatalogAccount​(GetCatalogAccountOptions getCatalogAccountOptions)
        Get catalog account settings. Get the account level settings for the account for private catalog.
        Parameters:
        getCatalogAccountOptions - the GetCatalogAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Account

      • getCatalogAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<Account> getCatalogAccount()
        Get catalog account settings. Get the account level settings for the account for private catalog.
        Returns:
        a ServiceCall with a result of type Account

      • updateCatalogAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateCatalogAccount​(UpdateCatalogAccountOptions updateCatalogAccountOptions)
        Update account settings. Update the account level settings for the account for private catalog.
        Parameters:
        updateCatalogAccountOptions - the UpdateCatalogAccountOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • updateCatalogAccount

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> updateCatalogAccount()
        Update account settings. Update the account level settings for the account for private catalog.
        Returns:
        a ServiceCall with a void result

      • getCatalogAccountAudit

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditLog> getCatalogAccountAudit​(GetCatalogAccountAuditOptions getCatalogAccountAuditOptions)
        Get catalog account audit log. Get the audit log associated with a catalog account.
        Parameters:
        getCatalogAccountAuditOptions - the GetCatalogAccountAuditOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AuditLog

      • getCatalogAccountAudit

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditLog> getCatalogAccountAudit()
        Get catalog account audit log. Get the audit log associated with a catalog account.
        Returns:
        a ServiceCall with a result of type AuditLog

      • getCatalogAccountFilters

        public com.ibm.cloud.sdk.core.http.ServiceCall<AccumulatedFilters> getCatalogAccountFilters()
        Get catalog account filters. Get the accumulated filters of the account and of the catalogs you have access to.
        Returns:
        a ServiceCall with a result of type AccumulatedFilters

      • listCatalogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogSearchResult> listCatalogs​(ListCatalogsOptions listCatalogsOptions)
        Get list of catalogs. Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.
        Parameters:
        listCatalogsOptions - the ListCatalogsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogSearchResult

      • listCatalogs

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogSearchResult> listCatalogs()
        Get list of catalogs. Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.
        Returns:
        a ServiceCall with a result of type CatalogSearchResult

      • createCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<Catalog> createCatalog​(CreateCatalogOptions createCatalogOptions)
        Create a catalog. Create a catalog for a given account.
        Parameters:
        createCatalogOptions - the CreateCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Catalog

      • createCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<Catalog> createCatalog()
        Create a catalog. Create a catalog for a given account.
        Returns:
        a ServiceCall with a result of type Catalog

      • getCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<Catalog> getCatalog​(GetCatalogOptions getCatalogOptions)
        Get catalog. Get a catalog. This can also be used by an unauthenticated user to get the public catalog.
        Parameters:
        getCatalogOptions - the GetCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Catalog

      • replaceCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<Catalog> replaceCatalog​(ReplaceCatalogOptions replaceCatalogOptions)
        Update catalog. Update a catalog.
        Parameters:
        replaceCatalogOptions - the ReplaceCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Catalog

      • deleteCatalog

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteCatalog​(DeleteCatalogOptions deleteCatalogOptions)
        Delete catalog. Delete a catalog.
        Parameters:
        deleteCatalogOptions - the DeleteCatalogOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getCatalogAudit

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditLog> getCatalogAudit​(GetCatalogAuditOptions getCatalogAuditOptions)
        Get catalog audit log. Get the audit log associated with a catalog.
        Parameters:
        getCatalogAuditOptions - the GetCatalogAuditOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AuditLog

      • getConsumptionOfferings

        public com.ibm.cloud.sdk.core.http.ServiceCall<OfferingSearchResult> getConsumptionOfferings​(GetConsumptionOfferingsOptions getConsumptionOfferingsOptions)
        Get consumption offerings. Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.
        Parameters:
        getConsumptionOfferingsOptions - the GetConsumptionOfferingsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type OfferingSearchResult

      • getConsumptionOfferings

        public com.ibm.cloud.sdk.core.http.ServiceCall<OfferingSearchResult> getConsumptionOfferings()
        Get consumption offerings. Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.
        Returns:
        a ServiceCall with a result of type OfferingSearchResult

      • listOfferings

        public com.ibm.cloud.sdk.core.http.ServiceCall<OfferingSearchResult> listOfferings​(ListOfferingsOptions listOfferingsOptions)
        Get list of offerings. Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.
        Parameters:
        listOfferingsOptions - the ListOfferingsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type OfferingSearchResult

      • createOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> createOffering​(CreateOfferingOptions createOfferingOptions)
        Create offering. Create an offering.
        Parameters:
        createOfferingOptions - the CreateOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • importOfferingVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> importOfferingVersion​(ImportOfferingVersionOptions importOfferingVersionOptions)
        Import offering version. Import new version to offering from a tgz.
        Parameters:
        importOfferingVersionOptions - the ImportOfferingVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • importOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> importOffering​(ImportOfferingOptions importOfferingOptions)
        Import offering. Import a new offering from a tgz.
        Parameters:
        importOfferingOptions - the ImportOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • reloadOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> reloadOffering​(ReloadOfferingOptions reloadOfferingOptions)
        Reload offering. Reload an existing version in offering from a tgz.
        Parameters:
        reloadOfferingOptions - the ReloadOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • getOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> getOffering​(GetOfferingOptions getOfferingOptions)
        Get offering. Get an offering. This can be used by an unauthenticated user for publicly available offerings.
        Parameters:
        getOfferingOptions - the GetOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • replaceOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> replaceOffering​(ReplaceOfferingOptions replaceOfferingOptions)
        Update offering. Update an offering.
        Parameters:
        replaceOfferingOptions - the ReplaceOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • updateOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> updateOffering​(UpdateOfferingOptions updateOfferingOptions)
        Update offering. Update an offering.
        Parameters:
        updateOfferingOptions - the UpdateOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • deleteOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteOffering​(DeleteOfferingOptions deleteOfferingOptions)
        Delete offering. Delete an offering.
        Parameters:
        deleteOfferingOptions - the DeleteOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getOfferingAudit

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditLog> getOfferingAudit​(GetOfferingAuditOptions getOfferingAuditOptions)
        Get offering audit log. Get the audit log associated with an offering.
        Parameters:
        getOfferingAuditOptions - the GetOfferingAuditOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AuditLog

      • replaceOfferingIcon

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> replaceOfferingIcon​(ReplaceOfferingIconOptions replaceOfferingIconOptions)
        Upload icon for offering. Upload an icon file to be stored in GC. File is uploaded as a binary payload - not as a form.
        Parameters:
        replaceOfferingIconOptions - the ReplaceOfferingIconOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • updateOfferingIbm

        public com.ibm.cloud.sdk.core.http.ServiceCall<ApprovalResult> updateOfferingIbm​(UpdateOfferingIbmOptions updateOfferingIbmOptions)
        Allow offering to be published. Approve or disapprove the offering to be allowed to publish to the IBM Public Catalog. Options: * `allow_request` - (Allow requesting to publish to IBM) * `ibm` - (Allow publishing to be visible to IBM only) * `public` - (Allow publishing to be visible to everyone, including IBM) If disapprove `public`, then `ibm` approval will not be changed. If disapprove `ibm` then `public` will automatically be disapproved. if disapprove `allow_request` then all rights to publish will be removed. This is because the process steps always go first through `allow` to `ibm` and then to `public`. `ibm` cannot be skipped. Only users with Approval IAM authority can use this. Approvers should use the catalog and offering id from the public catalog since they wouldn't have access to the private offering.
        Parameters:
        updateOfferingIbmOptions - the UpdateOfferingIbmOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ApprovalResult

      • deprecateOffering

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deprecateOffering​(DeprecateOfferingOptions deprecateOfferingOptions)
        Allows offering to be deprecated. Approve or disapprove the offering to be deprecated.
        Parameters:
        deprecateOfferingOptions - the DeprecateOfferingOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getOfferingUpdates

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.List<VersionUpdateDescriptor>> getOfferingUpdates​(GetOfferingUpdatesOptions getOfferingUpdatesOptions)
        Get version updates. Get available updates for the specified version.
        Parameters:
        getOfferingUpdatesOptions - the GetOfferingUpdatesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type List

      • getOfferingSource

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.io.InputStream> getOfferingSource​(GetOfferingSourceOptions getOfferingSourceOptions)
        Get offering source. Get an offering's source. This request requires authorization, even for public offerings.
        Parameters:
        getOfferingSourceOptions - the GetOfferingSourceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InputStream

      • getOfferingAbout

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.String> getOfferingAbout​(GetOfferingAboutOptions getOfferingAboutOptions)
        Get version about information. Get the about information, in markdown, for the current version.
        Parameters:
        getOfferingAboutOptions - the GetOfferingAboutOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type String

      • getOfferingLicense

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.String> getOfferingLicense​(GetOfferingLicenseOptions getOfferingLicenseOptions)
        Get version license content. Get the license content for the specified license ID in the specified version.
        Parameters:
        getOfferingLicenseOptions - the GetOfferingLicenseOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type String

      • getOfferingContainerImages

        public com.ibm.cloud.sdk.core.http.ServiceCall<ImageManifest> getOfferingContainerImages​(GetOfferingContainerImagesOptions getOfferingContainerImagesOptions)
        Get version's container images. Get the list of container images associated with the specified version. The "image_manifest_url" property of the version should be the URL for the image manifest, and the operation will return that content.
        Parameters:
        getOfferingContainerImagesOptions - the GetOfferingContainerImagesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ImageManifest

      • deprecateVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deprecateVersion​(DeprecateVersionOptions deprecateVersionOptions)
        Deprecate version immediately. Deprecate the specified version.
        Parameters:
        deprecateVersionOptions - the DeprecateVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • setDeprecateVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> setDeprecateVersion​(SetDeprecateVersionOptions setDeprecateVersionOptions)
        Sets version to be deprecated in a certain time period. Set or cancel the version to be deprecated.
        Parameters:
        setDeprecateVersionOptions - the SetDeprecateVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • accountPublishVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> accountPublishVersion​(AccountPublishVersionOptions accountPublishVersionOptions)
        Publish version to account members. Publish the specified version so it is viewable by account members.
        Parameters:
        accountPublishVersionOptions - the AccountPublishVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • ibmPublishVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> ibmPublishVersion​(IbmPublishVersionOptions ibmPublishVersionOptions)
        Publish version to IBMers in public catalog. Publish the specified version so that it is visible to IBMers in the public catalog.
        Parameters:
        ibmPublishVersionOptions - the IbmPublishVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • publicPublishVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> publicPublishVersion​(PublicPublishVersionOptions publicPublishVersionOptions)
        Publish version to all users in public catalog. Publish the specified version so it is visible to all users in the public catalog.
        Parameters:
        publicPublishVersionOptions - the PublicPublishVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • commitVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> commitVersion​(CommitVersionOptions commitVersionOptions)
        Commit version. Commit a working copy of the specified version.
        Parameters:
        commitVersionOptions - the CommitVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • copyVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> copyVersion​(CopyVersionOptions copyVersionOptions)
        Copy version to new target kind. Copy the specified version to a new target kind within the same offering.
        Parameters:
        copyVersionOptions - the CopyVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getOfferingWorkingCopy

        public com.ibm.cloud.sdk.core.http.ServiceCall<Version> getOfferingWorkingCopy​(GetOfferingWorkingCopyOptions getOfferingWorkingCopyOptions)
        Create working copy of version. Create a working copy of the specified version.
        Parameters:
        getOfferingWorkingCopyOptions - the GetOfferingWorkingCopyOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Version

      • getVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<Offering> getVersion​(GetVersionOptions getVersionOptions)
        Get offering/kind/version 'branch'. Get the Offering/Kind/Version 'branch' for the specified locator ID.
        Parameters:
        getVersionOptions - the GetVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Offering

      • deleteVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteVersion​(DeleteVersionOptions deleteVersionOptions)
        Delete version. Delete the specified version. If the version is an active version with a working copy, the working copy will be deleted as well.
        Parameters:
        deleteVersionOptions - the DeleteVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getCluster

        public com.ibm.cloud.sdk.core.http.ServiceCall<ClusterInfo> getCluster​(GetClusterOptions getClusterOptions)
        Get kubernetes cluster. Get the contents of the specified kubernetes cluster.
        Parameters:
        getClusterOptions - the GetClusterOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ClusterInfo

      • deployOperators

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.List<OperatorDeployResult>> deployOperators​(DeployOperatorsOptions deployOperatorsOptions)
        Deploy operators. Deploy operators on a kubernetes cluster.
        Parameters:
        deployOperatorsOptions - the DeployOperatorsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type List

      • listOperators

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.List<OperatorDeployResult>> listOperators​(ListOperatorsOptions listOperatorsOptions)
        List operators. List the operators from a kubernetes cluster.
        Parameters:
        listOperatorsOptions - the ListOperatorsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type List

      • replaceOperators

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.List<OperatorDeployResult>> replaceOperators​(ReplaceOperatorsOptions replaceOperatorsOptions)
        Update operators. Update the operators on a kubernetes cluster.
        Parameters:
        replaceOperatorsOptions - the ReplaceOperatorsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type List

      • deleteOperators

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteOperators​(DeleteOperatorsOptions deleteOperatorsOptions)
        Delete operators. Delete operators from a kubernetes cluster.
        Parameters:
        deleteOperatorsOptions - the DeleteOperatorsOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • installVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> installVersion​(InstallVersionOptions installVersionOptions)
        Install version. Create an install for the specified version.
        Parameters:
        installVersionOptions - the InstallVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • preinstallVersion

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> preinstallVersion​(PreinstallVersionOptions preinstallVersionOptions)
        Pre-install version. Create a pre-install for the specified version.
        Parameters:
        preinstallVersionOptions - the PreinstallVersionOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getPreinstall

        public com.ibm.cloud.sdk.core.http.ServiceCall<InstallStatus> getPreinstall​(GetPreinstallOptions getPreinstallOptions)
        Get version pre-install status. Get the pre-install status for the specified version.
        Parameters:
        getPreinstallOptions - the GetPreinstallOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type InstallStatus

      • validateInstall

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> validateInstall​(ValidateInstallOptions validateInstallOptions)
        Validate offering. Validate the offering associated with the specified version.
        Parameters:
        validateInstallOptions - the ValidateInstallOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getValidationStatus

        public com.ibm.cloud.sdk.core.http.ServiceCall<Validation> getValidationStatus​(GetValidationStatusOptions getValidationStatusOptions)
        Get offering install status. Returns the install status for the specified offering version.
        Parameters:
        getValidationStatusOptions - the GetValidationStatusOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Validation

      • getOverrideValues

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.util.Map<java.lang.String,​java.lang.Object>> getOverrideValues​(GetOverrideValuesOptions getOverrideValuesOptions)
        Get override values. Returns the override values that were used to validate the specified offering version.
        Parameters:
        getOverrideValuesOptions - the GetOverrideValuesOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type Map

      • searchObjects

        public com.ibm.cloud.sdk.core.http.ServiceCall<ObjectSearchResult> searchObjects​(SearchObjectsOptions searchObjectsOptions)
        List objects across catalogs. List the available objects from both public and private catalogs. These copies cannot be used for updating. They are not complete and only return what is visible to the caller.
        Parameters:
        searchObjectsOptions - the SearchObjectsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ObjectSearchResult

      • listObjects

        public com.ibm.cloud.sdk.core.http.ServiceCall<ObjectListResult> listObjects​(ListObjectsOptions listObjectsOptions)
        List objects within a catalog. List the available objects within the specified catalog.
        Parameters:
        listObjectsOptions - the ListObjectsOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ObjectListResult

      • createObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogObject> createObject​(CreateObjectOptions createObjectOptions)
        Create catalog object. Create an object with a specific catalog.
        Parameters:
        createObjectOptions - the CreateObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogObject

      • getObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogObject> getObject​(GetObjectOptions getObjectOptions)
        Get catalog object. Get the specified object from within the specified catalog.
        Parameters:
        getObjectOptions - the GetObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogObject

      • replaceObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogObject> replaceObject​(ReplaceObjectOptions replaceObjectOptions)
        Update catalog object. Update an object within a specific catalog.
        Parameters:
        replaceObjectOptions - the ReplaceObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type CatalogObject

      • deleteObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteObject​(DeleteObjectOptions deleteObjectOptions)
        Delete catalog object. Delete a specific object within a specific catalog.
        Parameters:
        deleteObjectOptions - the DeleteObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getObjectAudit

        public com.ibm.cloud.sdk.core.http.ServiceCall<AuditLog> getObjectAudit​(GetObjectAuditOptions getObjectAuditOptions)
        Get catalog object audit log. Get the audit log associated with a specific catalog object.
        Parameters:
        getObjectAuditOptions - the GetObjectAuditOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type AuditLog

      • accountPublishObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> accountPublishObject​(AccountPublishObjectOptions accountPublishObjectOptions)
        Publish object to account. Publish a catalog object to account.
        Parameters:
        accountPublishObjectOptions - the AccountPublishObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • sharedPublishObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> sharedPublishObject​(SharedPublishObjectOptions sharedPublishObjectOptions)
        Publish object to share with allow list. Publish the specified object so that it is visible to those in the allow list.
        Parameters:
        sharedPublishObjectOptions - the SharedPublishObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • ibmPublishObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> ibmPublishObject​(IbmPublishObjectOptions ibmPublishObjectOptions)
        Publish object to share with IBMers. Publish the specified object so that it is visible to IBMers in the public catalog.
        Parameters:
        ibmPublishObjectOptions - the IbmPublishObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • publicPublishObject

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> publicPublishObject​(PublicPublishObjectOptions publicPublishObjectOptions)
        Publish object to share with all users. Publish the specified object so it is visible to all users in the public catalog.
        Parameters:
        publicPublishObjectOptions - the PublicPublishObjectOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createObjectAccess

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> createObjectAccess​(CreateObjectAccessOptions createObjectAccessOptions)
        Add account ID to object access list. Add an account ID to an object's access list.
        Parameters:
        createObjectAccessOptions - the CreateObjectAccessOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • getObjectAccess

        public com.ibm.cloud.sdk.core.http.ServiceCall<ObjectAccess> getObjectAccess​(GetObjectAccessOptions getObjectAccessOptions)
        Check for account ID in object access list. Determine if an account ID is in an object's access list.
        Parameters:
        getObjectAccessOptions - the GetObjectAccessOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type ObjectAccess

      • deleteObjectAccess

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteObjectAccess​(DeleteObjectAccessOptions deleteObjectAccessOptions)
        Remove account ID from object access list. Delete the specified account ID from the specified object's access list.
        Parameters:
        deleteObjectAccessOptions - the DeleteObjectAccessOptions containing the options for the call
        Returns:
        a ServiceCall with a void result

      • createOfferingInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<OfferingInstance> createOfferingInstance​(CreateOfferingInstanceOptions createOfferingInstanceOptions)
        Create an offering resource instance. Provision a new offering in a given account, and return its resource instance.
        Parameters:
        createOfferingInstanceOptions - the CreateOfferingInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type OfferingInstance

      • getOfferingInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<OfferingInstance> getOfferingInstance​(GetOfferingInstanceOptions getOfferingInstanceOptions)
        Get Offering Instance. Get the resource associated with an installed offering instance.
        Parameters:
        getOfferingInstanceOptions - the GetOfferingInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a result of type OfferingInstance

      • deleteOfferingInstance

        public com.ibm.cloud.sdk.core.http.ServiceCall<java.lang.Void> deleteOfferingInstance​(DeleteOfferingInstanceOptions deleteOfferingInstanceOptions)
        Delete a version instance. Delete and instance deployed out of a product version.
        Parameters:
        deleteOfferingInstanceOptions - the DeleteOfferingInstanceOptions containing the options for the call
        Returns:
        a ServiceCall with a void result