Class GoogleRobotCredentials

  • All Implemented Interfaces:
    com.cloudbees.plugins.credentials.common.IdCredentials, com.cloudbees.plugins.credentials.common.StandardCredentials, com.cloudbees.plugins.credentials.common.StandardUsernameCredentials, com.cloudbees.plugins.credentials.common.UsernameCredentials, com.cloudbees.plugins.credentials.Credentials, GoogleOAuth2Credentials, com.google.jenkins.plugins.credentials.oauth.OAuth2Credentials<GoogleOAuth2ScopeRequirement>, com.google.jenkins.plugins.credentials.oauth.StandardUsernameOAuth2Credentials<GoogleOAuth2ScopeRequirement>, ExtensionPoint, Describable<com.cloudbees.plugins.credentials.Credentials>, Serializable
    Direct Known Subclasses:
    GoogleRobotMetadataCredentials, GoogleRobotPrivateKeyCredentials

    public abstract class GoogleRobotCredentials
    extends com.cloudbees.plugins.credentials.impl.BaseStandardCredentials
    implements GoogleOAuth2Credentials
    The base implementation of service account (aka robot) credentials using OAuth2. These robot credentials can be used to access Google APIs as the robot user.
    Author:
    Matt Moore
    See Also:
    Serialized Form
    • Constructor Detail

      • GoogleRobotCredentials

        @Deprecated
        protected GoogleRobotCredentials​(String projectId,
                                         GoogleRobotCredentialsModule module)
        Deprecated.
        Base constructor for populating the name and id for Google credentials.
        Parameters:
        projectId - The project id with which this credential is associated.
        module - The module to use for instantiating the dependencies of credentials.
      • GoogleRobotCredentials

        protected GoogleRobotCredentials​(@CheckForNull
                                         com.cloudbees.plugins.credentials.CredentialsScope scope,
                                         String id,
                                         String projectId,
                                         String description,
                                         GoogleRobotCredentialsModule module)
        Base constructor for populating the scope, name, id, and project id for Google credentials. Leave the id empty to generate a new one, populate the id when updating an existing credential or migrating from using the project id as the credential id. Use the scope to define the extent to which these credentials are available within Jenkins (i.e., GLOBAL or SYSTEM).
        Parameters:
        scope - The scope of the credentials, determining where they can be used in Jenkins. Can be either GLOBAL or SYSTEM.
        id - The credential ID to assign.
        projectId - The project id with which this credential is associated.
        description - The credential description
        module - The module to use for instantiating the dependencies of credentials.