Package privateca is an auto-generated package for the Certificate Authority API.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
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/v1beta1#CreateCertificateRequest. } resp , err := c . CreateCertificate ( ctx , req ) if err != nil { // TODO: Handle error. } // TODO: Use resp. _ = resp
Use of Context
The ctx passed to NewClient 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.
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
RestoreCertificateAuthority
[]
gax
.
CallOption
ScheduleDeleteCertificateAuthority
[]
gax
.
CallOption
UpdateCertificateAuthority
[]
gax
.
CallOption
GetCertificateRevocationList
[]
gax
.
CallOption
ListCertificateRevocationLists
[]
gax
.
CallOption
UpdateCertificateRevocationList
[]
gax
.
CallOption
GetReusableConfig
[]
gax
.
CallOption
ListReusableConfigs
[]
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.v1beta1.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.v1beta1.CertificateAuthorityService] manages private certificate authorities and issued certificates.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
)
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 PENDING_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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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) 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 CertificateAuthority.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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) 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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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) 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 PENDING_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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#FetchCertificateAuthorityCsrRequest.
}
resp
,
err
:=
c
.
FetchCertificateAuthorityCsr
(
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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#GetCertificateRevocationListRequest.
}
resp
,
err
:=
c
.
GetCertificateRevocationList
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) GetReusableConfig
func
(
c
*
CertificateAuthorityClient
)
GetReusableConfig
(
ctx
context
.
Context
,
req
*
privatecapb
.
GetReusableConfigRequest
,
opts
...
gax
.
CallOption
)
(
*
privatecapb
.
ReusableConfig
,
error
)
GetReusableConfig returns a ReusableConfig.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
GetReusableConfigRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1#GetReusableConfigRequest.
}
resp
,
err
:=
c
.
GetReusableConfig
(
ctx
,
req
)
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/apiv1beta1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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) 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/apiv1beta1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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) ListReusableConfigs
func
(
c
*
CertificateAuthorityClient
)
ListReusableConfigs
(
ctx
context
.
Context
,
req
*
privatecapb
.
ListReusableConfigsRequest
,
opts
...
gax
.
CallOption
)
*
ReusableConfigIterator
ListReusableConfigs lists ReusableConfigs.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
"google.golang.org/api/iterator"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ListReusableConfigsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1#ListReusableConfigsRequest.
}
it
:=
c
.
ListReusableConfigs
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*CertificateAuthorityClient) RestoreCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
RestoreCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
RestoreCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
RestoreCertificateAuthorityOperation
,
error
)
RestoreCertificateAuthority restore a CertificateAuthority that is scheduled for deletion.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
RestoreCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1#RestoreCertificateAuthorityRequest.
}
op
,
err
:=
c
.
RestoreCertificateAuthority
(
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) RestoreCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
RestoreCertificateAuthorityOperation
(
name
string
)
*
RestoreCertificateAuthorityOperation
RestoreCertificateAuthorityOperation returns a new RestoreCertificateAuthorityOperation from a given name. The name must be that of a previously created RestoreCertificateAuthorityOperation, possibly from a different process.
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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#RevokeCertificateRequest.
}
resp
,
err
:=
c
.
RevokeCertificate
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*CertificateAuthorityClient) ScheduleDeleteCertificateAuthority
func
(
c
*
CertificateAuthorityClient
)
ScheduleDeleteCertificateAuthority
(
ctx
context
.
Context
,
req
*
privatecapb
.
ScheduleDeleteCertificateAuthorityRequest
,
opts
...
gax
.
CallOption
)
(
*
ScheduleDeleteCertificateAuthorityOperation
,
error
)
ScheduleDeleteCertificateAuthority schedule a CertificateAuthority for deletion.
Example
package
main
import
(
"context"
privateca
"cloud.google.com/go/security/privateca/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
privateca
.
NewCertificateAuthorityClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& privatecapb
.
ScheduleDeleteCertificateAuthorityRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1#ScheduleDeleteCertificateAuthorityRequest.
}
op
,
err
:=
c
.
ScheduleDeleteCertificateAuthority
(
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) ScheduleDeleteCertificateAuthorityOperation
func
(
c
*
CertificateAuthorityClient
)
ScheduleDeleteCertificateAuthorityOperation
(
name
string
)
*
ScheduleDeleteCertificateAuthorityOperation
ScheduleDeleteCertificateAuthorityOperation returns a new ScheduleDeleteCertificateAuthorityOperation from a given name. The name must be that of a previously created ScheduleDeleteCertificateAuthorityOperation, 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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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/apiv1beta1"
privatecapb
"google.golang.org/genproto/googleapis/cloud/security/privateca/v1beta1"
)
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/v1beta1#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.
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.
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.
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.
RestoreCertificateAuthorityOperation
type
RestoreCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
RestoreCertificateAuthorityOperation manages a long-running operation from RestoreCertificateAuthority.
func (*RestoreCertificateAuthorityOperation) Done
func
(
op
*
RestoreCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*RestoreCertificateAuthorityOperation) Metadata
func
(
op
*
RestoreCertificateAuthorityOperation
)
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 (*RestoreCertificateAuthorityOperation) Name
func
(
op
*
RestoreCertificateAuthorityOperation
)
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 (*RestoreCertificateAuthorityOperation) Poll
func
(
op
*
RestoreCertificateAuthorityOperation
)
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 (*RestoreCertificateAuthorityOperation) Wait
func
(
op
*
RestoreCertificateAuthorityOperation
)
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.
ReusableConfigIterator
type
ReusableConfigIterator
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
.
ReusableConfig
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ReusableConfigIterator manages a stream of *privatecapb.ReusableConfig.
func (*ReusableConfigIterator) Next
func
(
it
*
ReusableConfigIterator
)
Next
()
(
*
privatecapb
.
ReusableConfig
,
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 (*ReusableConfigIterator) PageInfo
func
(
it
*
ReusableConfigIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
ScheduleDeleteCertificateAuthorityOperation
type
ScheduleDeleteCertificateAuthorityOperation
struct
{
// contains filtered or unexported fields
}
ScheduleDeleteCertificateAuthorityOperation manages a long-running operation from ScheduleDeleteCertificateAuthority.
func (*ScheduleDeleteCertificateAuthorityOperation) Done
func
(
op
*
ScheduleDeleteCertificateAuthorityOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*ScheduleDeleteCertificateAuthorityOperation) Metadata
func
(
op
*
ScheduleDeleteCertificateAuthorityOperation
)
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 (*ScheduleDeleteCertificateAuthorityOperation) Name
func
(
op
*
ScheduleDeleteCertificateAuthorityOperation
)
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 (*ScheduleDeleteCertificateAuthorityOperation) Poll
func
(
op
*
ScheduleDeleteCertificateAuthorityOperation
)
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 (*ScheduleDeleteCertificateAuthorityOperation) Wait
func
(
op
*
ScheduleDeleteCertificateAuthorityOperation
)
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.
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.
