Package privateca is an auto-generated package for the Certificate Authority API.
The Certificate Authority Service API is a highly-available, scalable service that enables you to simplify and automate the management of private certificate authorities (CAs) while staying in control of your private keys.
Example usage
To get started with this package, create a client.
ctx := context . Background () c , err := privateca . NewCertificateAuthorityClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close ()
The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.
Using the Client
The following is an example of making an API call with the newly created client.
ctx := context . Background () c , err := privateca . NewCertificateAuthorityClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & privatecapb . CreateCertificateRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#CreateCertificateRequest. } resp , err := c . CreateCertificate ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewCertificateAuthorityClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.
To close the open connection, use the Close() method.
For information about setting deadlines, reusing contexts, and more please visit https://pkg.go.dev/cloud.google.com/go .
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
ActivateCertificateAuthorityOperation
type
ActivateCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
ActivateCertificateAuthorityOperation manages a long-running operation from ActivateCertificateAuthority.
func (*ActivateCertificateAuthorityOperation) Done
func
(
op
*
ActivateCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ActivateCertificateAuthorityOperation) Metadata
func
(
op
*
ActivateCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*ActivateCertificateAuthorityOperation) Name
func
(
op
*
ActivateCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*ActivateCertificateAuthorityOperation) Poll
func
(
op
*
ActivateCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*ActivateCertificateAuthorityOperation) Wait
func
(
op
*
ActivateCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CaPoolIterator
type
CaPoolIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
privatecapb
.
CaPool
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CaPoolIterator manages a stream of *privatecapb.CaPool.
func (*CaPoolIterator) Next
func
(
it
*
CaPoolIterator
)
Next
()
(
*
privatecapb
.
CaPool
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CaPoolIterator) PageInfo
func
(
it
*
CaPoolIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CertificateAuthorityCallOptions
type
CertificateAuthorityCallOptions
struct
{
CreateCertificate
[]
gax
.
CallOption
GetCertificate
[]
gax
.
CallOption
ListCertificates
[]
gax
.
CallOption
RevokeCertificate
[]
gax
.
CallOption
UpdateCertificate
[]
gax
.
CallOption
ActivateCertificateAuthority
[]
gax
.
CallOption
CreateCertificateAuthority
[]
gax
.
CallOption
DisableCertificateAuthority
[]
gax
.
CallOption
EnableCertificateAuthority
[]
gax
.
CallOption
FetchCertificateAuthorityCsr
[]
gax
.
CallOption
GetCertificateAuthority
[]
gax
.
CallOption
ListCertificateAuthorities
[]
gax
.
CallOption
UndeleteCertificateAuthority
[]
gax
.
CallOption
DeleteCertificateAuthority
[]
gax
.
CallOption
UpdateCertificateAuthority
[]
gax
.
CallOption
CreateCaPool
[]
gax
.
CallOption
UpdateCaPool
[]
gax
.
CallOption
GetCaPool
[]
gax
.
CallOption
ListCaPools
[]
gax
.
CallOption
DeleteCaPool
[]
gax
.
CallOption
FetchCaCerts
[]
gax
.
CallOption
GetCertificateRevocationList
[]
gax
.
CallOption
ListCertificateRevocationLists
[]
gax
.
CallOption
UpdateCertificateRevocationList
[]
gax
.
CallOption
CreateCertificateTemplate
[]
gax
.
CallOption
DeleteCertificateTemplate
[]
gax
.
CallOption
GetCertificateTemplate
[]
gax
.
CallOption
ListCertificateTemplates
[]
gax
.
CallOption
UpdateCertificateTemplate
[]
gax
.
CallOption
GetLocation
[]
gax
.
CallOption
ListLocations
[]
gax
.
CallOption
GetIamPolicy
[]
gax
.
CallOption
SetIamPolicy
[]
gax
.
CallOption
TestIamPermissions
[]
gax
.
CallOption
}
CertificateAuthorityCallOptions contains the retry settings for each method of CertificateAuthorityClient.
CertificateAuthorityClient
type
CertificateAuthorityClient
struct
{
// The call options for this service.
CallOptions
*
CertificateAuthorityCallOptions
// LROClient is used internally to handle long-running operations.
// It is exposed so that its CallOptions can be modified if required.
// Users should not Close this client.
LROClient
*
lroauto
.
OperationsClient
// contains filtered or unexported fields
}
CertificateAuthorityClient is a client for interacting with Certificate Authority API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.
func NewCertificateAuthorityClient
func
NewCertificateAuthorityClient
(
ctx
context
.
Context
,
opts
...
option
.
ClientOption
)
(
*
CertificateAuthorityClient
,
error
)
NewCertificateAuthorityClient creates a new certificate authority service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
[Certificate Authority Service][google.cloud.security.privateca.v1.CertificateAuthorityService] manages private certificate authorities and issued certificates.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*CertificateAuthorityClient) ActivateCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
ActivateCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
ActivateCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
ActivateCertificateAuthorityOperation
,
error
)
ActivateCertificateAuthority activate a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. After the parent Certificate Authority signs a certificate signing request from FetchCertificateAuthorityCsr, this method can complete the activation process.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ActivateCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ActivateCertificateAuthorityRequest.
}
op
,
err
:=
c
.
ActivateCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) ActivateCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
ActivateCertificateAuthorityOperation
(
name
string
)
*
ActivateCertificateAuthorityOperation
ActivateCertificateAuthorityOperation returns a new ActivateCertificateAuthorityOperation from a given name. The name must be that of a previously created ActivateCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) Close
func
(
c
*
CertificateAuthorityClient
)
Close
()
error
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*CertificateAuthorityClient) Connection
func
(
c
*
CertificateAuthorityClient
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*CertificateAuthorityClient) CreateCaPool
func
(
c
*
CertificateAuthorityClient
)
CreateCaPool
(
ctx
context
.
Context
,
req
*
privatecapb
.
CreateCaPoolRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateCaPoolOperation
,
error
)
CreateCaPool create a CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
CreateCaPoolRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#CreateCaPoolRequest.
}
op
,
err
:=
c
.
CreateCaPool
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) CreateCaPoolOperation
func
(
c
*
CertificateAuthorityClient
)
CreateCaPoolOperation
(
name
string
)
*
CreateCaPoolOperation
CreateCaPoolOperation returns a new CreateCaPoolOperation from a given name. The name must be that of a previously created CreateCaPoolOperation, possibly from a different process.
func (*CertificateAuthorityClient) CreateCertificate
func
(
c
*
CertificateAuthorityClient
)
CreateCertificate
(
ctx
context
.
Context
,
req
*
privatecapb
.
CreateCertificateRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
Certificate
,
error
)
CreateCertificate create a new Certificate in a given Project, Location from a particular CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
CreateCertificateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#CreateCertificateRequest.
}
resp
,
err
:=
c
.
CreateCertificate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) CreateCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
CreateCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
CreateCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateCertificateAuthorityOperation
,
error
)
CreateCertificateAuthority create a new CertificateAuthority in a given Project and Location.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
CreateCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#CreateCertificateAuthorityRequest.
}
op
,
err
:=
c
.
CreateCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) CreateCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
CreateCertificateAuthorityOperation
(
name
string
)
*
CreateCertificateAuthorityOperation
CreateCertificateAuthorityOperation returns a new CreateCertificateAuthorityOperation from a given name. The name must be that of a previously created CreateCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) CreateCertificateTemplate
func
(
c
*
CertificateAuthorityClient
)
CreateCertificateTemplate
(
ctx
context
.
Context
,
req
*
privatecapb
.
CreateCertificateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateCertificateTemplateOperation
,
error
)
CreateCertificateTemplate create a new CertificateTemplate in a given Project and Location.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
CreateCertificateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#CreateCertificateTemplateRequest.
}
op
,
err
:=
c
.
CreateCertificateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) CreateCertificateTemplateOperation
func
(
c
*
CertificateAuthorityClient
)
CreateCertificateTemplateOperation
(
name
string
)
*
CreateCertificateTemplateOperation
CreateCertificateTemplateOperation returns a new CreateCertificateTemplateOperation from a given name. The name must be that of a previously created CreateCertificateTemplateOperation, possibly from a different process.
func (*CertificateAuthorityClient) DeleteCaPool
func
(
c
*
CertificateAuthorityClient
)
DeleteCaPool
(
ctx
context
.
Context
,
req
*
privatecapb
.
DeleteCaPoolRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteCaPoolOperation
,
error
)
DeleteCaPool delete a CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
DeleteCaPoolRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#DeleteCaPoolRequest.
}
op
,
err
:=
c
.
DeleteCaPool
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CertificateAuthorityClient) DeleteCaPoolOperation
func
(
c
*
CertificateAuthorityClient
)
DeleteCaPoolOperation
(
name
string
)
*
DeleteCaPoolOperation
DeleteCaPoolOperation returns a new DeleteCaPoolOperation from a given name. The name must be that of a previously created DeleteCaPoolOperation, possibly from a different process.
func (*CertificateAuthorityClient) DeleteCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
DeleteCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
DeleteCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteCertificateAuthorityOperation
,
error
)
DeleteCertificateAuthority delete a CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
DeleteCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#DeleteCertificateAuthorityRequest.
}
op
,
err
:=
c
.
DeleteCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) DeleteCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
DeleteCertificateAuthorityOperation
(
name
string
)
*
DeleteCertificateAuthorityOperation
DeleteCertificateAuthorityOperation returns a new DeleteCertificateAuthorityOperation from a given name. The name must be that of a previously created DeleteCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) DeleteCertificateTemplate
func
(
c
*
CertificateAuthorityClient
)
DeleteCertificateTemplate
(
ctx
context
.
Context
,
req
*
privatecapb
.
DeleteCertificateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteCertificateTemplateOperation
,
error
)
DeleteCertificateTemplate deleteCertificateTemplate deletes a CertificateTemplate.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
DeleteCertificateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#DeleteCertificateTemplateRequest.
}
op
,
err
:=
c
.
DeleteCertificateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*CertificateAuthorityClient) DeleteCertificateTemplateOperation
func
(
c
*
CertificateAuthorityClient
)
DeleteCertificateTemplateOperation
(
name
string
)
*
DeleteCertificateTemplateOperation
DeleteCertificateTemplateOperation returns a new DeleteCertificateTemplateOperation from a given name. The name must be that of a previously created DeleteCertificateTemplateOperation, possibly from a different process.
func (*CertificateAuthorityClient) DisableCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
DisableCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
DisableCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
DisableCertificateAuthorityOperation
,
error
)
DisableCertificateAuthority disable a CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
DisableCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#DisableCertificateAuthorityRequest.
}
op
,
err
:=
c
.
DisableCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) DisableCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
DisableCertificateAuthorityOperation
(
name
string
)
*
DisableCertificateAuthorityOperation
DisableCertificateAuthorityOperation returns a new DisableCertificateAuthorityOperation from a given name. The name must be that of a previously created DisableCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) EnableCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
EnableCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
EnableCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
EnableCertificateAuthorityOperation
,
error
)
EnableCertificateAuthority enable a CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
EnableCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#EnableCertificateAuthorityRequest.
}
op
,
err
:=
c
.
EnableCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) EnableCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
EnableCertificateAuthorityOperation
(
name
string
)
*
EnableCertificateAuthorityOperation
EnableCertificateAuthorityOperation returns a new EnableCertificateAuthorityOperation from a given name. The name must be that of a previously created EnableCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) FetchCaCerts
func
(
c
*
CertificateAuthorityClient
)
FetchCaCerts
(
ctx
context
.
Context
,
req
*
privatecapb
.
FetchCaCertsRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
FetchCaCertsResponse
,
error
)
FetchCaCerts fetchCaCerts returns the current trust anchor for the CaPool. This will include CA certificate chains for all ACTIVE CertificateAuthority resources in the CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
FetchCaCertsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#FetchCaCertsRequest.
}
resp
,
err
:=
c
.
FetchCaCerts
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) FetchCertificateAuthorityCsr
func
(
c
*
CertificateAuthorityClient
)
FetchCertificateAuthorityCsr
(
ctx
context
.
Context
,
req
*
privatecapb
.
FetchCertificateAuthorityCsrRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
FetchCertificateAuthorityCsrResponse
,
error
)
FetchCertificateAuthorityCsr fetch a certificate signing request (CSR) from a CertificateAuthority that is in state AWAITING_USER_ACTIVATION and is of type SUBORDINATE. The CSR must then be signed by the desired parent Certificate Authority, which could be another CertificateAuthority resource, or could be an on-prem certificate authority. See also ActivateCertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
FetchCertificateAuthorityCsrRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#FetchCertificateAuthorityCsrRequest.
}
resp
,
err
:=
c
.
FetchCertificateAuthorityCsr
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetCaPool
func
(
c
*
CertificateAuthorityClient
)
GetCaPool
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetCaPoolRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CaPool
,
error
)
GetCaPool returns a CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetCaPoolRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#GetCaPoolRequest.
}
resp
,
err
:=
c
.
GetCaPool
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetCertificate
func
(
c
*
CertificateAuthorityClient
)
GetCertificate
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetCertificateRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
Certificate
,
error
)
GetCertificate returns a Certificate.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetCertificateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#GetCertificateRequest.
}
resp
,
err
:=
c
.
GetCertificate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
GetCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
GetCertificateAuthority returns a CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#GetCertificateAuthorityRequest.
}
resp
,
err
:=
c
.
GetCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetCertificateRevocationList
func
(
c
*
CertificateAuthorityClient
)
GetCertificateRevocationList
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetCertificateRevocationListRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateRevocationList
,
error
)
GetCertificateRevocationList returns a CertificateRevocationList.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetCertificateRevocationListRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#GetCertificateRevocationListRequest.
}
resp
,
err
:=
c
.
GetCertificateRevocationList
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetCertificateTemplate
func
(
c
*
CertificateAuthorityClient
)
GetCertificateTemplate
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetCertificateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateTemplate
,
error
)
GetCertificateTemplate returns a CertificateTemplate.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetCertificateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#GetCertificateTemplateRequest.
}
resp
,
err
:=
c
.
GetCertificateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetIamPolicy
func
(
c
*
CertificateAuthorityClient
)
GetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
GetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
GetIamPolicy gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
iampb
"google.golang.org/genproto/googleapis/iam/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
GetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#GetIamPolicyRequest.
}
resp
,
err
:=
c
.
GetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetLocation
func
(
c
*
CertificateAuthorityClient
)
GetLocation
(
ctx
context
.
Context
,
req
*
locationpb
.
GetLocationRequest
,
opts
...
gax
.
CallOption
)
(
*
locationpb
.
Location
,
error
)
GetLocation gets information about a location.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
GetLocationRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#GetLocationRequest.
}
resp
,
err
:=
c
.
GetLocation
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) ListCaPools
func
(
c
*
CertificateAuthorityClient
)
ListCaPools
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListCaPoolsRequest
,
opts
...
gax
.
CallOption
)
*
CaPoolIterator
ListCaPools lists CaPools.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListCaPoolsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ListCaPoolsRequest.
}
it
:=
c
.
ListCaPools
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) ListCertificateAuthorities
func
(
c
*
CertificateAuthorityClient
)
ListCertificateAuthorities
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListCertificateAuthoritiesRequest
,
opts
...
gax
.
CallOption
)
*
CertificateAuthorityIterator
ListCertificateAuthorities lists CertificateAuthorities.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListCertificateAuthoritiesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ListCertificateAuthoritiesRequest.
}
it
:=
c
.
ListCertificateAuthorities
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) ListCertificateRevocationLists
func
(
c
*
CertificateAuthorityClient
)
ListCertificateRevocationLists
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListCertificateRevocationListsRequest
,
opts
...
gax
.
CallOption
)
*
CertificateRevocationListIterator
ListCertificateRevocationLists lists CertificateRevocationLists.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListCertificateRevocationListsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ListCertificateRevocationListsRequest.
}
it
:=
c
.
ListCertificateRevocationLists
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) ListCertificateTemplates
func
(
c
*
CertificateAuthorityClient
)
ListCertificateTemplates
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListCertificateTemplatesRequest
,
opts
...
gax
.
CallOption
)
*
CertificateTemplateIterator
ListCertificateTemplates lists CertificateTemplates.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListCertificateTemplatesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ListCertificateTemplatesRequest.
}
it
:=
c
.
ListCertificateTemplates
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) ListCertificates
func
(
c
*
CertificateAuthorityClient
)
ListCertificates
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListCertificatesRequest
,
opts
...
gax
.
CallOption
)
*
CertificateIterator
ListCertificates lists Certificates.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListCertificatesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#ListCertificatesRequest.
}
it
:=
c
.
ListCertificates
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) ListLocations
func
(
c
*
CertificateAuthorityClient
)
ListLocations
(
ctx
context
.
Context
,
req
*
locationpb
.
ListLocationsRequest
,
opts
...
gax
.
CallOption
)
*
LocationIterator
ListLocations lists information about the supported locations for this service.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
"google.golang.org/api/iterator"
locationpb
"google.golang.org/genproto/googleapis/cloud/location"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& locationpb
.
ListLocationsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/location#ListLocationsRequest.
}
it
:=
c
.
ListLocations
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) RevokeCertificate
func
(
c
*
CertificateAuthorityClient
)
RevokeCertificate
(
ctx
context
.
Context
,
req
*
privatecapb
.
RevokeCertificateRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
Certificate
,
error
)
RevokeCertificate revoke a Certificate.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
RevokeCertificateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#RevokeCertificateRequest.
}
resp
,
err
:=
c
.
RevokeCertificate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) SetIamPolicy
func
(
c
*
CertificateAuthorityClient
)
SetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
SetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
SetIamPolicy sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
iampb
"google.golang.org/genproto/googleapis/iam/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
SetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#SetIamPolicyRequest.
}
resp
,
err
:=
c
.
SetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) TestIamPermissions
func
(
c
*
CertificateAuthorityClient
)
TestIamPermissions
(
ctx
context
.
Context
,
req
*
iampb
.
TestIamPermissionsRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
TestIamPermissionsResponse
,
error
)
TestIamPermissions returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
iampb
"google.golang.org/genproto/googleapis/iam/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
TestIamPermissionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/iam/v1#TestIamPermissionsRequest.
}
resp
,
err
:=
c
.
TestIamPermissions
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UndeleteCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
UndeleteCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
UndeleteCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
UndeleteCertificateAuthorityOperation
,
error
)
UndeleteCertificateAuthority undelete a CertificateAuthority that has been deleted.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UndeleteCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UndeleteCertificateAuthorityRequest.
}
op
,
err
:=
c
.
UndeleteCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UndeleteCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
UndeleteCertificateAuthorityOperation
(
name
string
)
*
UndeleteCertificateAuthorityOperation
UndeleteCertificateAuthorityOperation returns a new UndeleteCertificateAuthorityOperation from a given name. The name must be that of a previously created UndeleteCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) UpdateCaPool
func
(
c
*
CertificateAuthorityClient
)
UpdateCaPool
(
ctx
context
.
Context
,
req
*
privatecapb
.
UpdateCaPoolRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateCaPoolOperation
,
error
)
UpdateCaPool update a CaPool.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UpdateCaPoolRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UpdateCaPoolRequest.
}
op
,
err
:=
c
.
UpdateCaPool
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UpdateCaPoolOperation
func
(
c
*
CertificateAuthorityClient
)
UpdateCaPoolOperation
(
name
string
)
*
UpdateCaPoolOperation
UpdateCaPoolOperation returns a new UpdateCaPoolOperation from a given name. The name must be that of a previously created UpdateCaPoolOperation, possibly from a different process.
func (*CertificateAuthorityClient) UpdateCertificate
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificate
(
ctx
context
.
Context
,
req
*
privatecapb
.
UpdateCertificateRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
Certificate
,
error
)
UpdateCertificate update a Certificate. Currently, the only field you can update is the labels field.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UpdateCertificateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UpdateCertificateRequest.
}
resp
,
err
:=
c
.
UpdateCertificate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UpdateCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
UpdateCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateCertificateAuthorityOperation
,
error
)
UpdateCertificateAuthority update a CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UpdateCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UpdateCertificateAuthorityRequest.
}
op
,
err
:=
c
.
UpdateCertificateAuthority
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UpdateCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateAuthorityOperation
(
name
string
)
*
UpdateCertificateAuthorityOperation
UpdateCertificateAuthorityOperation returns a new UpdateCertificateAuthorityOperation from a given name. The name must be that of a previously created UpdateCertificateAuthorityOperation, possibly from a different process.
func (*CertificateAuthorityClient) UpdateCertificateRevocationList
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateRevocationList
(
ctx
context
.
Context
,
req
*
privatecapb
.
UpdateCertificateRevocationListRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateCertificateRevocationListOperation
,
error
)
UpdateCertificateRevocationList update a CertificateRevocationList.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UpdateCertificateRevocationListRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UpdateCertificateRevocationListRequest.
}
op
,
err
:=
c
.
UpdateCertificateRevocationList
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UpdateCertificateRevocationListOperation
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateRevocationListOperation
(
name
string
)
*
UpdateCertificateRevocationListOperation
UpdateCertificateRevocationListOperation returns a new UpdateCertificateRevocationListOperation from a given name. The name must be that of a previously created UpdateCertificateRevocationListOperation, possibly from a different process.
func (*CertificateAuthorityClient) UpdateCertificateTemplate
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateTemplate
(
ctx
context
.
Context
,
req
*
privatecapb
.
UpdateCertificateTemplateRequest
,
opts
...
gax
.
CallOption
)
(
*
UpdateCertificateTemplateOperation
,
error
)
UpdateCertificateTemplate update a CertificateTemplate.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
UpdateCertificateTemplateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1#UpdateCertificateTemplateRequest.
}
op
,
err
:=
c
.
UpdateCertificateTemplate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) UpdateCertificateTemplateOperation
func
(
c
*
CertificateAuthorityClient
)
UpdateCertificateTemplateOperation
(
name
string
)
*
UpdateCertificateTemplateOperation
UpdateCertificateTemplateOperation returns a new UpdateCertificateTemplateOperation from a given name. The name must be that of a previously created UpdateCertificateTemplateOperation, possibly from a different process.
CertificateAuthorityIterator
type
CertificateAuthorityIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
privatecapb
.
CertificateAuthority
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CertificateAuthorityIterator manages a stream of *privatecapb.CertificateAuthority.
func (*CertificateAuthorityIterator) Next
func
(
it
*
CertificateAuthorityIterator
)
Next
()
(
*
privatecapb
.
CertificateAuthority
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CertificateAuthorityIterator) PageInfo
func
(
it
*
CertificateAuthorityIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CertificateIterator
type
CertificateIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
privatecapb
.
Certificate
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CertificateIterator manages a stream of *privatecapb.Certificate.
func (*CertificateIterator) Next
func
(
it
*
CertificateIterator
)
Next
()
(
*
privatecapb
.
Certificate
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CertificateIterator) PageInfo
func
(
it
*
CertificateIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CertificateRevocationListIterator
type
CertificateRevocationListIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
privatecapb
.
CertificateRevocationList
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CertificateRevocationListIterator manages a stream of *privatecapb.CertificateRevocationList.
func (*CertificateRevocationListIterator) Next
func
(
it
*
CertificateRevocationListIterator
)
Next
()
(
*
privatecapb
.
CertificateRevocationList
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CertificateRevocationListIterator) PageInfo
func
(
it
*
CertificateRevocationListIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CertificateTemplateIterator
type
CertificateTemplateIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
privatecapb
.
CertificateTemplate
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
CertificateTemplateIterator manages a stream of *privatecapb.CertificateTemplate.
func (*CertificateTemplateIterator) Next
func
(
it
*
CertificateTemplateIterator
)
Next
()
(
*
privatecapb
.
CertificateTemplate
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*CertificateTemplateIterator) PageInfo
func
(
it
*
CertificateTemplateIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
CreateCaPoolOperation
type
CreateCaPoolOperation
struct
{
// contains filtered or unexported fields
}
CreateCaPoolOperation manages a long-running operation from CreateCaPool.
func (*CreateCaPoolOperation) Done
func
(
op
*
CreateCaPoolOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateCaPoolOperation) Metadata
func
(
op
*
CreateCaPoolOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateCaPoolOperation) Name
func
(
op
*
CreateCaPoolOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateCaPoolOperation) Poll
func
(
op
*
CreateCaPoolOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CaPool
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateCaPoolOperation) Wait
func
(
op
*
CreateCaPoolOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CaPool
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CreateCertificateAuthorityOperation
type
CreateCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
CreateCertificateAuthorityOperation manages a long-running operation from CreateCertificateAuthority.
func (*CreateCertificateAuthorityOperation) Done
func
(
op
*
CreateCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateCertificateAuthorityOperation) Metadata
func
(
op
*
CreateCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateCertificateAuthorityOperation) Name
func
(
op
*
CreateCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateCertificateAuthorityOperation) Poll
func
(
op
*
CreateCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateCertificateAuthorityOperation) Wait
func
(
op
*
CreateCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
CreateCertificateTemplateOperation
type
CreateCertificateTemplateOperation
struct
{
// contains filtered or unexported fields
}
CreateCertificateTemplateOperation manages a long-running operation from CreateCertificateTemplate.
func (*CreateCertificateTemplateOperation) Done
func
(
op
*
CreateCertificateTemplateOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateCertificateTemplateOperation) Metadata
func
(
op
*
CreateCertificateTemplateOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*CreateCertificateTemplateOperation) Name
func
(
op
*
CreateCertificateTemplateOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*CreateCertificateTemplateOperation) Poll
func
(
op
*
CreateCertificateTemplateOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateTemplate
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*CreateCertificateTemplateOperation) Wait
func
(
op
*
CreateCertificateTemplateOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateTemplate
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteCaPoolOperation
type
DeleteCaPoolOperation
struct
{
// contains filtered or unexported fields
}
DeleteCaPoolOperation manages a long-running operation from DeleteCaPool.
func (*DeleteCaPoolOperation) Done
func
(
op
*
DeleteCaPoolOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteCaPoolOperation) Metadata
func
(
op
*
DeleteCaPoolOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteCaPoolOperation) Name
func
(
op
*
DeleteCaPoolOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteCaPoolOperation) Poll
func
(
op
*
DeleteCaPoolOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteCaPoolOperation) Wait
func
(
op
*
DeleteCaPoolOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteCertificateAuthorityOperation
type
DeleteCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
DeleteCertificateAuthorityOperation manages a long-running operation from DeleteCertificateAuthority.
func (*DeleteCertificateAuthorityOperation) Done
func
(
op
*
DeleteCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteCertificateAuthorityOperation) Metadata
func
(
op
*
DeleteCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteCertificateAuthorityOperation) Name
func
(
op
*
DeleteCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteCertificateAuthorityOperation) Poll
func
(
op
*
DeleteCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteCertificateAuthorityOperation) Wait
func
(
op
*
DeleteCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DeleteCertificateTemplateOperation
type
DeleteCertificateTemplateOperation
struct
{
// contains filtered or unexported fields
}
DeleteCertificateTemplateOperation manages a long-running operation from DeleteCertificateTemplate.
func (*DeleteCertificateTemplateOperation) Done
func
(
op
*
DeleteCertificateTemplateOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteCertificateTemplateOperation) Metadata
func
(
op
*
DeleteCertificateTemplateOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DeleteCertificateTemplateOperation) Name
func
(
op
*
DeleteCertificateTemplateOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DeleteCertificateTemplateOperation) Poll
func
(
op
*
DeleteCertificateTemplateOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DeleteCertificateTemplateOperation) Wait
func
(
op
*
DeleteCertificateTemplateOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
error
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
DisableCertificateAuthorityOperation
type
DisableCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
DisableCertificateAuthorityOperation manages a long-running operation from DisableCertificateAuthority.
func (*DisableCertificateAuthorityOperation) Done
func
(
op
*
DisableCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DisableCertificateAuthorityOperation) Metadata
func
(
op
*
DisableCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*DisableCertificateAuthorityOperation) Name
func
(
op
*
DisableCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*DisableCertificateAuthorityOperation) Poll
func
(
op
*
DisableCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*DisableCertificateAuthorityOperation) Wait
func
(
op
*
DisableCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
EnableCertificateAuthorityOperation
type
EnableCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
EnableCertificateAuthorityOperation manages a long-running operation from EnableCertificateAuthority.
func (*EnableCertificateAuthorityOperation) Done
func
(
op
*
EnableCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*EnableCertificateAuthorityOperation) Metadata
func
(
op
*
EnableCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*EnableCertificateAuthorityOperation) Name
func
(
op
*
EnableCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*EnableCertificateAuthorityOperation) Poll
func
(
op
*
EnableCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*EnableCertificateAuthorityOperation) Wait
func
(
op
*
EnableCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
LocationIterator
type
LocationIterator
struct
{
// Response is the raw response for the current page.
// It must be cast to the RPC response type.
// Calling Next() or InternalFetch() updates this value.
Response
interface
{}
// InternalFetch is for use by the Google Cloud Libraries only.
// It is not part of the stable interface of this package.
//
// InternalFetch returns results from a single call to the underlying RPC.
// The number of results is no greater than pageSize.
// If there are no more results, nextPageToken is empty and err is nil.
InternalFetch
func
(
pageSize
int
,
pageToken
string
)
(
results
[]
*
locationpb
.
Location
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
LocationIterator manages a stream of *locationpb.Location.
func (*LocationIterator) Next
func
(
it
*
LocationIterator
)
Next
()
(
*
locationpb
.
Location
,
error
)
Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.
func (*LocationIterator) PageInfo
func
(
it
*
LocationIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
UndeleteCertificateAuthorityOperation
type
UndeleteCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
UndeleteCertificateAuthorityOperation manages a long-running operation from UndeleteCertificateAuthority.
func (*UndeleteCertificateAuthorityOperation) Done
func
(
op
*
UndeleteCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UndeleteCertificateAuthorityOperation) Metadata
func
(
op
*
UndeleteCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UndeleteCertificateAuthorityOperation) Name
func
(
op
*
UndeleteCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UndeleteCertificateAuthorityOperation) Poll
func
(
op
*
UndeleteCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UndeleteCertificateAuthorityOperation) Wait
func
(
op
*
UndeleteCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateCaPoolOperation
type
UpdateCaPoolOperation
struct
{
// contains filtered or unexported fields
}
UpdateCaPoolOperation manages a long-running operation from UpdateCaPool.
func (*UpdateCaPoolOperation) Done
func
(
op
*
UpdateCaPoolOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateCaPoolOperation) Metadata
func
(
op
*
UpdateCaPoolOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateCaPoolOperation) Name
func
(
op
*
UpdateCaPoolOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateCaPoolOperation) Poll
func
(
op
*
UpdateCaPoolOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CaPool
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateCaPoolOperation) Wait
func
(
op
*
UpdateCaPoolOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CaPool
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateCertificateAuthorityOperation
type
UpdateCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
UpdateCertificateAuthorityOperation manages a long-running operation from UpdateCertificateAuthority.
func (*UpdateCertificateAuthorityOperation) Done
func
(
op
*
UpdateCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateCertificateAuthorityOperation) Metadata
func
(
op
*
UpdateCertificateAuthorityOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateCertificateAuthorityOperation) Name
func
(
op
*
UpdateCertificateAuthorityOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateCertificateAuthorityOperation) Poll
func
(
op
*
UpdateCertificateAuthorityOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateCertificateAuthorityOperation) Wait
func
(
op
*
UpdateCertificateAuthorityOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateAuthority
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateCertificateRevocationListOperation
type
UpdateCertificateRevocationListOperation
struct
{
// contains filtered or unexported fields
}
UpdateCertificateRevocationListOperation manages a long-running operation from UpdateCertificateRevocationList.
func (*UpdateCertificateRevocationListOperation) Done
func
(
op
*
UpdateCertificateRevocationListOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateCertificateRevocationListOperation) Metadata
func
(
op
*
UpdateCertificateRevocationListOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateCertificateRevocationListOperation) Name
func
(
op
*
UpdateCertificateRevocationListOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateCertificateRevocationListOperation) Poll
func
(
op
*
UpdateCertificateRevocationListOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateRevocationList
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateCertificateRevocationListOperation) Wait
func
(
op
*
UpdateCertificateRevocationListOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateRevocationList
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
UpdateCertificateTemplateOperation
type
UpdateCertificateTemplateOperation
struct
{
// contains filtered or unexported fields
}
UpdateCertificateTemplateOperation manages a long-running operation from UpdateCertificateTemplate.
func (*UpdateCertificateTemplateOperation) Done
func
(
op
*
UpdateCertificateTemplateOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*UpdateCertificateTemplateOperation) Metadata
func
(
op
*
UpdateCertificateTemplateOperation
)
Metadata
()
(
*
privatecapb
.
OperationMetadata
,
error
)
Metadata returns metadata associated with the long-running operation. Metadata itself does not contact the server, but Poll does. To get the latest metadata, call this method after a successful call to Poll. If the metadata is not available, the returned metadata and error are both nil.
func (*UpdateCertificateTemplateOperation) Name
func
(
op
*
UpdateCertificateTemplateOperation
)
Name
()
string
Name returns the name of the long-running operation. The name is assigned by the server and is unique within the service from which the operation is created.
func (*UpdateCertificateTemplateOperation) Poll
func
(
op
*
UpdateCertificateTemplateOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateTemplate
,
error
)
Poll fetches the latest state of the long-running operation.
Poll also fetches the latest metadata, which can be retrieved by Metadata.
If Poll fails, the error is returned and op is unmodified. If Poll succeeds and the operation has completed with failure, the error is returned and op.Done will return true. If Poll succeeds and the operation has completed successfully, op.Done will return true, and the response of the operation is returned. If Poll succeeds and the operation has not completed, the returned response and error are both nil.
func (*UpdateCertificateTemplateOperation) Wait
func
(
op
*
UpdateCertificateTemplateOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
CertificateTemplate
,
error
)
Wait blocks until the long-running operation is completed, returning the response and any errors encountered.
See documentation of Poll for error-handling information.
