Package ids is an auto-generated package for the Cloud IDS API.
Cloud IDS (Cloud Intrusion Detection System) detects malware, spyware, command-and-control attacks, and other network-based threats. Its security efficacy is industry leading, built with Palo Alto Networks technologies. When you use this product, your organization name and consumption levels will be shared with Palo Alto Networks.
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 := ids . 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.
ctx := context . Background () c , err := ids . NewClient ( ctx ) if err != nil { // TODO: Handle error. } defer c . Close () req := & idspb . ListEndpointsRequest { // TODO: Fill request struct fields. // See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/ids/v1#ListEndpointsRequest. } it := c . ListEndpoints ( ctx , req ) for { resp , err := it . Next () if err == iterator . Done { break } 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.
CallOptions
type
CallOptions
struct
{
ListEndpoints
[]
gax
.
CallOption
GetEndpoint
[]
gax
.
CallOption
CreateEndpoint
[]
gax
.
CallOption
DeleteEndpoint
[]
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 Cloud IDS API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.
The IDS Service
func NewClient
NewClient creates a new ids client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.
The IDS Service
Example
package
main
import
(
"context"
ids
"cloud.google.com/go/ids/apiv1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
ids
.
NewClient
(
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
func
(
c
*
Client
)
Connection
()
*
grpc
.
ClientConn
Connection returns a connection to the API service.
Deprecated.
func (*Client) CreateEndpoint
func
(
c
*
Client
)
CreateEndpoint
(
ctx
context
.
Context
,
req
*
idspb
.
CreateEndpointRequest
,
opts
...
gax
.
CallOption
)
(
*
CreateEndpointOperation
,
error
)
CreateEndpoint creates a new Endpoint in a given project and location.
Example
package
main
import
(
"context"
ids
"cloud.google.com/go/ids/apiv1"
idspb
"google.golang.org/genproto/googleapis/cloud/ids/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
ids
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& idspb
.
CreateEndpointRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/ids/v1#CreateEndpointRequest.
}
op
,
err
:=
c
.
CreateEndpoint
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
resp
,
err
:=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) CreateEndpointOperation
func
(
c
*
Client
)
CreateEndpointOperation
(
name
string
)
*
CreateEndpointOperation
CreateEndpointOperation returns a new CreateEndpointOperation from a given name. The name must be that of a previously created CreateEndpointOperation, possibly from a different process.
func (*Client) DeleteEndpoint
func
(
c
*
Client
)
DeleteEndpoint
(
ctx
context
.
Context
,
req
*
idspb
.
DeleteEndpointRequest
,
opts
...
gax
.
CallOption
)
(
*
DeleteEndpointOperation
,
error
)
DeleteEndpoint deletes a single Endpoint.
Example
package
main
import
(
"context"
ids
"cloud.google.com/go/ids/apiv1"
idspb
"google.golang.org/genproto/googleapis/cloud/ids/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
ids
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& idspb
.
DeleteEndpointRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/ids/v1#DeleteEndpointRequest.
}
op
,
err
:=
c
.
DeleteEndpoint
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
err
=
op
.
Wait
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
}
func (*Client) DeleteEndpointOperation
func
(
c
*
Client
)
DeleteEndpointOperation
(
name
string
)
*
DeleteEndpointOperation
DeleteEndpointOperation returns a new DeleteEndpointOperation from a given name. The name must be that of a previously created DeleteEndpointOperation, possibly from a different process.
func (*Client) GetEndpoint
func
(
c
*
Client
)
GetEndpoint
(
ctx
context
.
Context
,
req
*
idspb
.
GetEndpointRequest
,
opts
...
gax
.
CallOption
)
(
*
idspb
.
Endpoint
,
error
)
GetEndpoint gets details of a single Endpoint.
Example
package
main
import
(
"context"
ids
"cloud.google.com/go/ids/apiv1"
idspb
"google.golang.org/genproto/googleapis/cloud/ids/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
ids
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& idspb
.
GetEndpointRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/ids/v1#GetEndpointRequest.
}
resp
,
err
:=
c
.
GetEndpoint
(
ctx
,
req
)
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
func (*Client) ListEndpoints
func
(
c
*
Client
)
ListEndpoints
(
ctx
context
.
Context
,
req
*
idspb
.
ListEndpointsRequest
,
opts
...
gax
.
CallOption
)
*
EndpointIterator
ListEndpoints lists Endpoints in a given project and location.
Example
package
main
import
(
"context"
ids
"cloud.google.com/go/ids/apiv1"
"google.golang.org/api/iterator"
idspb
"google.golang.org/genproto/googleapis/cloud/ids/v1"
)
func
main
()
{
ctx
:=
context
.
Background
()
c
,
err
:=
ids
.
NewClient
(
ctx
)
if
err
!=
nil
{
// TODO: Handle error.
}
defer
c
.
Close
()
req
:=
& idspb
.
ListEndpointsRequest
{
// TODO: Fill request struct fields.
// See https://pkg.go.dev/google.golang.org/genproto/googleapis/cloud/ids/v1#ListEndpointsRequest.
}
it
:=
c
.
ListEndpoints
(
ctx
,
req
)
for
{
resp
,
err
:=
it
.
Next
()
if
err
==
iterator
.
Done
{
break
}
if
err
!=
nil
{
// TODO: Handle error.
}
// TODO: Use resp.
_
=
resp
}
}
CreateEndpointOperation
type
CreateEndpointOperation
struct
{
// contains filtered or unexported fields
}
CreateEndpointOperation manages a long-running operation from CreateEndpoint.
func (*CreateEndpointOperation) Done
func
(
op
*
CreateEndpointOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*CreateEndpointOperation) Metadata
func
(
op
*
CreateEndpointOperation
)
Metadata
()
(
*
idspb
.
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 (*CreateEndpointOperation) Name
func
(
op
*
CreateEndpointOperation
)
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 (*CreateEndpointOperation) Poll
func
(
op
*
CreateEndpointOperation
)
Poll
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
idspb
.
Endpoint
,
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 (*CreateEndpointOperation) Wait
func
(
op
*
CreateEndpointOperation
)
Wait
(
ctx
context
.
Context
,
opts
...
gax
.
CallOption
)
(
*
idspb
.
Endpoint
,
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.
DeleteEndpointOperation
type
DeleteEndpointOperation
struct
{
// contains filtered or unexported fields
}
DeleteEndpointOperation manages a long-running operation from DeleteEndpoint.
func (*DeleteEndpointOperation) Done
func
(
op
*
DeleteEndpointOperation
)
Done
()
bool
Done reports whether the long-running operation has completed.
func (*DeleteEndpointOperation) Metadata
func
(
op
*
DeleteEndpointOperation
)
Metadata
()
(
*
idspb
.
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 (*DeleteEndpointOperation) Name
func
(
op
*
DeleteEndpointOperation
)
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 (*DeleteEndpointOperation) Poll
func
(
op
*
DeleteEndpointOperation
)
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 (*DeleteEndpointOperation) Wait
func
(
op
*
DeleteEndpointOperation
)
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.
EndpointIterator
type
EndpointIterator
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
[]
*
idspb
.
Endpoint
,
nextPageToken
string
,
err
error
)
// contains filtered or unexported fields
}
EndpointIterator manages a stream of *idspb.Endpoint.
func (*EndpointIterator) Next
func
(
it
*
EndpointIterator
)
Next
()
(
*
idspb
.
Endpoint
,
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 (*EndpointIterator) PageInfo
func
(
it
*
EndpointIterator
)
PageInfo
()
*
iterator
.
PageInfo
PageInfo supports pagination. See the google.golang.org/api/iterator package for details.
