Package securitycenter is an auto-generated package for the Security Command Center API.
Security Command Center API provides access to temporal views of assets and findings within an organization.
NOTE : This package is in beta . It is not stable , and may be subject to changes .
General documentation
For information that is relevant for all client libraries please reference https://pkg.go.dev/cloud.google.com/go#pkg-overview . Some information on this page includes:
- Authentication and Authorization
- Timeouts and Cancellation
- Testing against Client Libraries
- Debugging Client Libraries
- Inspecting errors
Example usage
To get started with this package, create a client.
// go get cloud.google.com/go/securitycenter/apiv1beta1@latest ctx := context . Background () // This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in: // https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options c , err := securitycenter . NewClient ( 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, mentioned above.
req := & securitycenterpb . CreateFindingRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#CreateFindingRequest. } resp , err := c . CreateFinding ( 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.
Functions
func DefaultAuthScopes
func
DefaultAuthScopes
()
[]
string
DefaultAuthScopes reports the default set of authentication scopes to use with this package.
CallOptions
type
CallOptions
struct
{
CreateSource
[]
gax
.
CallOption
CreateFinding
[]
gax
.
CallOption
GetIamPolicy
[]
gax
.
CallOption
GetOrganizationSettings
[]
gax
.
CallOption
GetSource
[]
gax
.
CallOption
GroupAssets
[]
gax
.
CallOption
GroupFindings
[]
gax
.
CallOption
ListAssets
[]
gax
.
CallOption
ListFindings
[]
gax
.
CallOption
ListSources
[]
gax
.
CallOption
RunAssetDiscovery
[]
gax
.
CallOption
SetFindingState
[]
gax
.
CallOption
SetIamPolicy
[]
gax
.
CallOption
TestIamPermissions
[]
gax
.
CallOption
UpdateFinding
[]
gax
.
CallOption
UpdateOrganizationSettings
[]
gax
.
CallOption
UpdateSource
[]
gax
.
CallOption
UpdateSecurityMarks
[]
gax
.
CallOption
}
CallOptions contains the retry settings for each method of Client.
Client
type
Client
struct
{
// The call options for this service.
CallOptions
*
CallOptions
// 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
}
Client is a client for interacting with Security Command Center API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
V1 Beta APIs for Security Center service.
func NewClient
NewClient creates a new security center client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
V1 Beta APIs for Security Center service.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func NewRESTClient
NewRESTClient creates a new security center rest client.
V1 Beta APIs for Security Center service.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewRESTClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
// TODO: Use client.
_
=
c
}
func (*Client) Close
Close closes the connection to the API service. The user should invoke this when the client is no longer required.
func (*Client) Connection (deprecated)
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated: Connections are now pooled so this method does not always return the same resource.
func (*Client) CreateFinding
func
(
c
*
Client
)
CreateFinding
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
CreateFindingRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Finding
,
error
)
CreateFinding creates a finding. The corresponding source must exist for finding creation to succeed.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
CreateFindingRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#CreateFindingRequest.
}
resp
,
err
:=
c
.
CreateFinding
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateSource
func
(
c
*
Client
)
CreateSource
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
CreateSourceRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Source
,
error
)
CreateSource creates a source.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
CreateSourceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#CreateSourceRequest.
}
resp
,
err
:=
c
.
CreateSource
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetIamPolicy
func
(
c
*
Client
)
GetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
GetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
GetIamPolicy gets the access control policy on the specified Source.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
GetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#GetIamPolicyRequest.
}
resp
,
err
:=
c
.
GetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetOrganizationSettings
func
(
c
*
Client
)
GetOrganizationSettings
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
GetOrganizationSettingsRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
OrganizationSettings
,
error
)
GetOrganizationSettings gets the settings for an organization.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GetOrganizationSettingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GetOrganizationSettingsRequest.
}
resp
,
err
:=
c
.
GetOrganizationSettings
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GetSource
func
(
c
*
Client
)
GetSource
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
GetSourceRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Source
,
error
)
GetSource gets a source.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GetSourceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GetSourceRequest.
}
resp
,
err
:=
c
.
GetSource
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) GroupAssets
func
(
c
*
Client
)
GroupAssets
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
GroupAssetsRequest
,
opts
...
gax
.
CallOption
)
*
GroupResultIterator
GroupAssets filters an organization’s assets and groups them by their specified properties.
Examples
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GroupAssetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GroupAssetsRequest.
}
it
:=
c
.
GroupAssets
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
securitycenterpb
.
GroupAssetsResponse
)
}
}
all
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GroupAssetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GroupAssetsRequest.
}
for
resp
,
err
:=
range
c
.
GroupAssets
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) GroupFindings
func
(
c
*
Client
)
GroupFindings
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
GroupFindingsRequest
,
opts
...
gax
.
CallOption
)
*
GroupResultIterator
GroupFindings filters an organization or source’s findings and groups them by their specified properties.
To group across all sources provide a - as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings
Examples
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GroupFindingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GroupFindingsRequest.
}
it
:=
c
.
GroupFindings
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
securitycenterpb
.
GroupFindingsResponse
)
}
}
all
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
GroupFindingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#GroupFindingsRequest.
}
for
resp
,
err
:=
range
c
.
GroupFindings
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListAssets
func
(
c
*
Client
)
ListAssets
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
ListAssetsRequest
,
opts
...
gax
.
CallOption
)
*
ListAssetsResponse_ListAssetsResultIterator
ListAssets lists an organization’s assets.
Examples
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListAssetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListAssetsRequest.
}
it
:=
c
.
ListAssets
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
securitycenterpb
.
ListAssetsResponse
)
}
}
all
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListAssetsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListAssetsRequest.
}
for
resp
,
err
:=
range
c
.
ListAssets
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListFindings
func
(
c
*
Client
)
ListFindings
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
ListFindingsRequest
,
opts
...
gax
.
CallOption
)
*
FindingIterator
ListFindings lists an organization or source’s findings.
To list across all sources provide a - as the source id. Example: /v1beta1/organizations/{organization_id}/sources/-/findings
Examples
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListFindingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListFindingsRequest.
}
it
:=
c
.
ListFindings
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
securitycenterpb
.
ListFindingsResponse
)
}
}
all
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListFindingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListFindingsRequest.
}
for
resp
,
err
:=
range
c
.
ListFindings
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) ListSources
func
(
c
*
Client
)
ListSources
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
ListSourcesRequest
,
opts
...
gax
.
CallOption
)
*
SourceIterator
ListSources lists all sources belonging to an organization.
Examples
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
"google.golang.org/api/iterator"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListSourcesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListSourcesRequest.
}
it
:=
c
.
ListSources
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
// If you need to access the underlying RPC response,
// you can do so by casting the `Response` as below.
// Otherwise, remove this line. Only populated after
// first call to Next(). Not safe for concurrent access.
_
=
it
.
Response
.(
*
securitycenterpb
.
ListSourcesResponse
)
}
}
all
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
ListSourcesRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#ListSourcesRequest.
}
for
resp
,
err
:=
range
c
.
ListSources
(
ctx
,
req
).
All
()
{
if
err
!=
nil
{
// TODO: Handle error and break/return/continue. Iteration will stop after any error.
}
// TODO: Use resp.
_
=
resp
}
}
func (*Client) RunAssetDiscovery
func
(
c
*
Client
)
RunAssetDiscovery
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
RunAssetDiscoveryRequest
,
opts
...
gax
.
CallOption
)
(
*
RunAssetDiscoveryOperation
,
error
)
RunAssetDiscovery runs asset discovery. The discovery is tracked with a long-running operation.
This API can only be called with limited frequency for an organization. If it is called too frequently the caller will receive a TOO_MANY_REQUESTS error.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
RunAssetDiscoveryRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#RunAssetDiscoveryRequest.
}
op
,
err
:=
c
.
RunAssetDiscovery
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) RunAssetDiscoveryOperation
func
(
c
*
Client
)
RunAssetDiscoveryOperation
(
name
string
)
*
RunAssetDiscoveryOperation
RunAssetDiscoveryOperation returns a new RunAssetDiscoveryOperation from a given name. The name must be that of a previously created RunAssetDiscoveryOperation, possibly from a different process.
func (*Client) SetFindingState
func
(
c
*
Client
)
SetFindingState
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
SetFindingStateRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Finding
,
error
)
SetFindingState updates the state of a finding.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
SetFindingStateRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#SetFindingStateRequest.
}
resp
,
err
:=
c
.
SetFindingState
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) SetIamPolicy
func
(
c
*
Client
)
SetIamPolicy
(
ctx
context
.
Context
,
req
*
iampb
.
SetIamPolicyRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
Policy
,
error
)
SetIamPolicy sets the access control policy on the specified Source.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
SetIamPolicyRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#SetIamPolicyRequest.
}
resp
,
err
:=
c
.
SetIamPolicy
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) TestIamPermissions
func
(
c
*
Client
)
TestIamPermissions
(
ctx
context
.
Context
,
req
*
iampb
.
TestIamPermissionsRequest
,
opts
...
gax
.
CallOption
)
(
*
iampb
.
TestIamPermissionsResponse
,
error
)
TestIamPermissions returns the permissions that a caller has on the specified source.
Example
package
main
import
(
"context"
iampb
"cloud.google.com/go/iam/apiv1/iampb"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& iampb
.
TestIamPermissionsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/iam/apiv1/iampb#TestIamPermissionsRequest.
}
resp
,
err
:=
c
.
TestIamPermissions
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateFinding
func
(
c
*
Client
)
UpdateFinding
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
UpdateFindingRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Finding
,
error
)
UpdateFinding creates or updates a finding. The corresponding source must exist for a finding creation to succeed.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
UpdateFindingRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#UpdateFindingRequest.
}
resp
,
err
:=
c
.
UpdateFinding
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateOrganizationSettings
func
(
c
*
Client
)
UpdateOrganizationSettings
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
UpdateOrganizationSettingsRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
OrganizationSettings
,
error
)
UpdateOrganizationSettings updates an organization’s settings.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
UpdateOrganizationSettingsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#UpdateOrganizationSettingsRequest.
}
resp
,
err
:=
c
.
UpdateOrganizationSettings
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateSecurityMarks
func
(
c
*
Client
)
UpdateSecurityMarks
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
UpdateSecurityMarksRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
SecurityMarks
,
error
)
UpdateSecurityMarks updates security marks.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
UpdateSecurityMarksRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#UpdateSecurityMarksRequest.
}
resp
,
err
:=
c
.
UpdateSecurityMarks
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) UpdateSource
func
(
c
*
Client
)
UpdateSource
(
ctx
context
.
Context
,
req
*
securitycenterpb
.
UpdateSourceRequest
,
opts
...
gax
.
CallOption
)
(
*
securitycenterpb
.
Source
,
error
)
UpdateSource updates a source.
Example
package
main
import
(
"context"
securitycenter
"cloud.google.com/go/securitycenter/apiv1beta1"
securitycenterpb
"cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb"
)
func
main
()
{
ctx
:=
context
.
Background
()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
// https://pkg.go.dev/cloud.google.com/go#hdr-Client_Options
c
,
err
:=
securitycenter
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& securitycenterpb
.
UpdateSourceRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/cloud.google.com/go/securitycenter/apiv1beta1/securitycenterpb#UpdateSourceRequest.
}
resp
,
err
:=
c
.
UpdateSource
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
FindingIterator
type
FindingIterator
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
[]
*
securitycenterpb
.
Finding
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
FindingIterator manages a stream of *securitycenterpb.Finding.
func (*FindingIterator) All
func
(
it
*
FindingIterator
)
All
()
iter
.
Seq2
[
*
securitycenterpb
.
Finding
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*FindingIterator) Next
func
(
it
*
FindingIterator
)
Next
()
(
*
securitycenterpb
.
Finding
,
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 (*FindingIterator) PageInfo
func
(
it
*
FindingIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
GroupResultIterator
type
GroupResultIterator
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
[]
*
securitycenterpb
.
GroupResult
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
GroupResultIterator manages a stream of *securitycenterpb.GroupResult.
func (*GroupResultIterator) All
func
(
it
*
GroupResultIterator
)
All
()
iter
.
Seq2
[
*
securitycenterpb
.
GroupResult
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*GroupResultIterator) Next
func
(
it
*
GroupResultIterator
)
Next
()
(
*
securitycenterpb
.
GroupResult
,
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 (*GroupResultIterator) PageInfo
func
(
it
*
GroupResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
ListAssetsResponse_ListAssetsResultIterator
type
ListAssetsResponse_ListAssetsResultIterator
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
[]
*
securitycenterpb
.
ListAssetsResponse_ListAssetsResult
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
ListAssetsResponse_ListAssetsResultIterator manages a stream of *securitycenterpb.ListAssetsResponse_ListAssetsResult.
func (*ListAssetsResponse_ListAssetsResultIterator) All
func
(
it
*
ListAssetsResponse_ListAssetsResultIterator
)
All
()
iter
.
Seq2
[
*
securitycenterpb
.
ListAssetsResponse_ListAssetsResult
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*ListAssetsResponse_ListAssetsResultIterator) Next
func
(
it
*
ListAssetsResponse_ListAssetsResultIterator
)
Next
()
(
*
securitycenterpb
.
ListAssetsResponse_ListAssetsResult
,
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 (*ListAssetsResponse_ListAssetsResultIterator) PageInfo
func
(
it
*
ListAssetsResponse_ListAssetsResultIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
RunAssetDiscoveryOperation
type
RunAssetDiscoveryOperation
struct
{
// contains filtered or unexported fields
}
RunAssetDiscoveryOperation manages a long-running operation from RunAssetDiscovery.
func (*RunAssetDiscoveryOperation) Done
func
(
op
*
RunAssetDiscoveryOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*RunAssetDiscoveryOperation) Metadata
func
(
op
*
RunAssetDiscoveryOperation
)
Metadata
()
(
*
emptypb
.
Empty
,
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 (*RunAssetDiscoveryOperation) Name
func
(
op
*
RunAssetDiscoveryOperation
)
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 (*RunAssetDiscoveryOperation) Poll
func
(
op
*
RunAssetDiscoveryOperation
)
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 (*RunAssetDiscoveryOperation) Wait
func
(
op
*
RunAssetDiscoveryOperation
)
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.
SourceIterator
type
SourceIterator
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
[]
*
securitycenterpb
.
Source
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
SourceIterator manages a stream of *securitycenterpb.Source.
func (*SourceIterator) All
func
(
it
*
SourceIterator
)
All
()
iter
.
Seq2
[
*
securitycenterpb
.
Source
,
error
]
All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.
func (*SourceIterator) Next
func
(
it
*
SourceIterator
)
Next
()
(
*
securitycenterpb
.
Source
,
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 (*SourceIterator) PageInfo
func
(
it
*
SourceIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the [google.golang.org/api/iterator] package for details.
