Package com.google.jenkins.plugins.credentials.oauth

Class GoogleRobotMetadataCredentials

  • 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, com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials, 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
    @NameWith(value=GoogleRobotNameProvider.class,
          priority=50)
public final class GoogleRobotMetadataCredentials
extends GoogleRobotCredentials
implements com.cloudbees.plugins.credentials.domains.DomainRestrictedCredentials
    An implementation of GoogleRobotCredentials that produces OAuth2 access tokens using the metadata service attached to Google Compute instances. These Credentials are inherently limited to the set of OAuth2 scopes that a Google Compute instance is bound to at startup.

    NOTE: This plugin is only available to Jenkins masters running on a Google Compute Engine virtual machine.

    Author:
    Matt Moore
    See Also:
    Serialized Form

    • Constructor Detail

      • GoogleRobotMetadataCredentials

        @Deprecated
public GoogleRobotMetadataCredentials​(String projectId,
                                      @Nullable
                                      GoogleRobotMetadataCredentialsModule module)
                               throws Exception
        Deprecated.
        Construct a set of service account credentials.
        Parameters:
        projectId - The Pantheon project id associated with this service account
        module - The module for instantiating dependent objects, or null.
        Throws:
        Exception

      • GoogleRobotMetadataCredentials

        @DataBoundConstructor
public GoogleRobotMetadataCredentials​(@CheckForNull
                                      com.cloudbees.plugins.credentials.CredentialsScope scope,
                                      String id,
                                      String projectId,
                                      String description,
                                      @Nullable
                                      GoogleRobotMetadataCredentialsModule module)
                               throws Exception
        Construct a set of service account credentials with a specific id. It helps for updating credentials, as well as for migrating old credentials that had no id and relied on the project id.
        Parameters:
        scope - The scope of the credentials, determining where they can be used in Jenkins. Can be either GLOBAL or SYSTEM.
        id - the id to assign
        projectId - The Pantheon project id associated with this service account
        description - The credential description
        module - The module for instantiating dependent objects, or null.
        Throws:
        Exception