target.apidocs.com.google.api.services.sqladmin.SQLAdmin.SslCerts.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-sqladmin Show documentation

There is a newer version: v1-rev20241108-2.0.0

Show newest version







SQLAdmin.SslCerts (Cloud SQL Admin API v1-rev20240925-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.sqladmin
Class SQLAdmin.SslCerts



java.lang.Object


com.google.api.services.sqladmin.SQLAdmin.SslCerts







Enclosing class:
SQLAdmin




public class SQLAdmin.SslCerts
extends Object
The "sslCerts" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
SQLAdmin.SslCerts.CreateEphemeral 


class 
SQLAdmin.SslCerts.Delete 


class 
SQLAdmin.SslCerts.Get 


class 
SQLAdmin.SslCerts.Insert 


class 
SQLAdmin.SslCerts.List 









Constructor Summary

Constructors 

Constructor and Description


SslCerts() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


SQLAdmin.SslCerts.CreateEphemeral
createEphemeral(String project,
               String instance,
               SslCertsCreateEphemeralRequest content)
Generates a short-lived X509 certificate containing the provided public key and signed by a
 private key specific to the target instance.



SQLAdmin.SslCerts.Delete
delete(String project,
      String instance,
      String sha1Fingerprint)
Deletes the SSL certificate.



SQLAdmin.SslCerts.Get
get(String project,
   String instance,
   String sha1Fingerprint)
Retrieves a particular SSL certificate.



SQLAdmin.SslCerts.Insert
insert(String project,
      String instance,
      SslCertsInsertRequest content)
Creates an SSL certificate and returns it along with the private key and server certificate
 authority.



SQLAdmin.SslCerts.List
list(String project,
    String instance)
Lists all of the current SSL certificates for the instance.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





SslCerts
public SslCerts()









Method Detail





createEphemeral
public SQLAdmin.SslCerts.CreateEphemeral createEphemeral(String project,
                                                         String instance,
                                                         SslCertsCreateEphemeralRequest content)
                                                  throws IOException
Generates a short-lived X509 certificate containing the provided public key and signed by a
 private key specific to the target instance. Users may use the certificate to authenticate as
 themselves when connecting to the database.

 Create a request for the method "sslCerts.createEphemeral".

 This request holds the parameters needed by the sqladmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID of the Cloud SQL project.
instance - Cloud SQL instance ID. This does not include the project ID.
content - the SslCertsCreateEphemeralRequest
Returns:
the request
Throws:
IOException








delete
public SQLAdmin.SslCerts.Delete delete(String project,
                                       String instance,
                                       String sha1Fingerprint)
                                throws IOException
Deletes the SSL certificate. For First Generation instances, the certificate remains valid until
 the instance is restarted.

 Create a request for the method "sslCerts.delete".

 This request holds the parameters needed by the sqladmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID of the project that contains the instance.
instance - Cloud SQL instance ID. This does not include the project ID.
sha1Fingerprint - Sha1 FingerPrint.
Returns:
the request
Throws:
IOException








get
public SQLAdmin.SslCerts.Get get(String project,
                                 String instance,
                                 String sha1Fingerprint)
                          throws IOException
Retrieves a particular SSL certificate. Does not include the private key (required for usage).
 The private key must be saved from the response to initial creation.

 Create a request for the method "sslCerts.get".

 This request holds the parameters needed by the sqladmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID of the project that contains the instance.
instance - Cloud SQL instance ID. This does not include the project ID.
sha1Fingerprint - Sha1 FingerPrint.
Returns:
the request
Throws:
IOException








insert
public SQLAdmin.SslCerts.Insert insert(String project,
                                       String instance,
                                       SslCertsInsertRequest content)
                                throws IOException
Creates an SSL certificate and returns it along with the private key and server certificate
 authority. The new certificate will not be usable until the instance is restarted.

 Create a request for the method "sslCerts.insert".

 This request holds the parameters needed by the sqladmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID of the project that contains the instance.
instance - Cloud SQL instance ID. This does not include the project ID.
content - the SslCertsInsertRequest
Returns:
the request
Throws:
IOException








list
public SQLAdmin.SslCerts.List list(String project,
                                   String instance)
                            throws IOException
Lists all of the current SSL certificates for the instance.

 Create a request for the method "sslCerts.list".

 This request holds the parameters needed by the sqladmin server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:
project - Project ID of the project that contains the instance.
instance - Cloud SQL instance ID. This does not include the project ID.
Returns:
the request
Throws:
IOException














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Class and Description
`class`	`SQLAdmin.SslCerts.CreateEphemeral`
`class`	`SQLAdmin.SslCerts.Delete`
`class`	`SQLAdmin.SslCerts.Get`
`class`	`SQLAdmin.SslCerts.Insert`
`class`	`SQLAdmin.SslCerts.List`

Modifier and Type	Method and Description
`SQLAdmin.SslCerts.CreateEphemeral`	`createEphemeral(String project, String instance, SslCertsCreateEphemeralRequest content)` Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance.
`SQLAdmin.SslCerts.Delete`	`delete(String project, String instance, String sha1Fingerprint)` Deletes the SSL certificate.
`SQLAdmin.SslCerts.Get`	`get(String project, String instance, String sha1Fingerprint)` Retrieves a particular SSL certificate.
`SQLAdmin.SslCerts.Insert`	`insert(String project, String instance, SslCertsInsertRequest content)` Creates an SSL certificate and returns it along with the private key and server certificate authority.
`SQLAdmin.SslCerts.List`	`list(String project, String instance)` Lists all of the current SSL certificates for the instance.