Class Credentials

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel

    public class Credentials
    extends com.ibm.cloud.sdk.core.service.model.DynamicModel<java.lang.Object>
    The credentials for a resource.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  Credentials.Redacted
      If present, the user doesn't have the correct access to view the credentials and the details are redacted.
    • Constructor Summary

      Constructors 
      Constructor Description
      Credentials()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getApikey()
      Gets the apikey.
      java.lang.String getIamApikeyDescription()
      Gets the iamApikeyDescription.
      java.lang.String getIamApikeyName()
      Gets the iamApikeyName.
      java.lang.String getIamRoleCrn()
      Gets the iamRoleCrn.
      java.lang.String getIamServiceidCrn()
      Gets the iamServiceidCrn.
      java.lang.String getRedacted()
      Gets the redacted.
      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.DynamicModel

        equals, get, getAdditionalPropertyTypeToken, getProperties, getPropertyNames, hashCode, put, removeProperties, removeProperty, setProperties, toString
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • Credentials

        public Credentials()
    • Method Detail

      • getRedacted

        public java.lang.String getRedacted()
        Gets the redacted. If present, the user doesn't have the correct access to view the credentials and the details are redacted. The string value identifies the level of access that's required to view the credential. For additional information, see [viewing a credential](https://cloud.ibm.com/docs/account?topic=account-service_credentials&interface=ui#viewing-credentials-ui).
        Returns:
        the redacted
      • getApikey

        public java.lang.String getApikey()
        Gets the apikey. The API key for the credentials.
        Returns:
        the apikey
      • getIamApikeyDescription

        public java.lang.String getIamApikeyDescription()
        Gets the iamApikeyDescription. The optional description of the API key.
        Returns:
        the iamApikeyDescription
      • getIamApikeyName

        public java.lang.String getIamApikeyName()
        Gets the iamApikeyName. The name of the API key.
        Returns:
        the iamApikeyName
      • getIamRoleCrn

        public java.lang.String getIamRoleCrn()
        Gets the iamRoleCrn. The Cloud Resource Name for the role of the credentials.
        Returns:
        the iamRoleCrn
      • getIamServiceidCrn

        public java.lang.String getIamServiceidCrn()
        Gets the iamServiceidCrn. The Cloud Resource Name for the service ID of the credentials.
        Returns:
        the iamServiceidCrn