IDSClient
(
*
,
credentials
:
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
Optional
[
Union
[
str
,
google
.
cloud
.
ids_v1
.
services
.
ids
.
transports
.
base
.
IDSTransport
]]
=
None
,
client_options
:
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> )
The IDS Service
Properties
transport
Returns the transport used by the client instance.
IDSTransport
Methods
IDSClient
IDSClient
(
*
,
credentials
:
Optional
[
google
.
auth
.
credentials
.
Credentials
]
=
None
,
transport
:
Optional
[
Union
[
str
,
google
.
cloud
.
ids_v1
.
services
.
ids
.
transports
.
base
.
IDSTransport
]]
=
None
,
client_options
:
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
client_info
:
google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> )
Instantiates the ids client.
credentials
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
transport
Union[str, IDSTransport]
The transport to use. If set to None, a transport is chosen automatically.
client_options
google.api_core.client_options.ClientOptions
Custom options for the client. It won't take effect if a transport
instance is provided. (1) The api_endpoint
property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint
property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source
property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.
client_info
google.api_core.gapic_v1.client_info.ClientInfo
The client info used to send a user-agent string along with API requests. If None
, then default info will be used. Generally, you only need to set this if you're developing your own client library.
google.auth.exceptions.MutualTLSChannelError
__exit__
__exit__
(
type
,
value
,
traceback
)
Releases underlying transport's resources.
common_billing_account_path
common_billing_account_path
(
billing_account
:
str
)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path
(
folder
:
str
)
Returns a fully-qualified folder string.
common_location_path
common_location_path
(
project
:
str
,
location
:
str
)
Returns a fully-qualified location string.
common_organization_path
common_organization_path
(
organization
:
str
)
Returns a fully-qualified organization string.
common_project_path
common_project_path
(
project
:
str
)
Returns a fully-qualified project string.
create_endpoint
create_endpoint
(
request
:
Optional
[
Union
[
google
.
cloud
.
ids_v1
.
types
.
ids
.
CreateEndpointRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
endpoint
:
Optional
[
google
.
cloud
.
ids_v1
.
types
.
ids
.
Endpoint
]
=
None
,
endpoint_id
:
Optional
[
str
]
=
None
,
retry
:
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Creates a new Endpoint in a given project and location.
from google.cloud import ids_v1
def sample_create_endpoint():
# Create a client
client = ids_v1
. IDSClient
()
# Initialize request argument(s)
endpoint = ids_v1
. Endpoint
()
endpoint.network = "network_value"
endpoint.severity = "CRITICAL"
request = ids_v1
. CreateEndpointRequest
(
parent="parent_value",
endpoint_id="endpoint_id_value",
endpoint=endpoint,
)
# Make the request
operation = client. create_endpoint
(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
request
parent
str
Required. The endpoint's parent. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
endpoint
google.cloud.ids_v1.types.Endpoint
Required. The endpoint to create. This corresponds to the endpoint
field on the request
instance; if request
is provided, this should not be set.
endpoint_id
str
Required. The endpoint identifier. This will be part of the endpoint's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. Values that do not match this pattern will trigger an INVALID_ARGUMENT error. This corresponds to the endpoint_id
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
delete_endpoint
delete_endpoint
(
request
:
Optional
[
Union
[
google
.
cloud
.
ids_v1
.
types
.
ids
.
DeleteEndpointRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Deletes a single Endpoint.
from google.cloud import ids_v1
def sample_delete_endpoint():
# Create a client
client = ids_v1
. IDSClient
()
# Initialize request argument(s)
request = ids_v1
. DeleteEndpointRequest
(
name="name_value",
)
# Make the request
operation = client. delete_endpoint
(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
request
name
str
Required. The name of the endpoint to delete. This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
google.api_core.operation.Operation
google.protobuf.empty_pb2.Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.endpoint_path
endpoint_path
(
project
:
str
,
location
:
str
,
endpoint
:
str
)
Returns a fully-qualified endpoint string.
from_service_account_file
from_service_account_file
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
IDSClient
from_service_account_info
from_service_account_info
(
info
:
dict
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials info.
info
dict
The service account private key info.
IDSClient
from_service_account_json
from_service_account_json
(
filename
:
str
,
*
args
,
**
kwargs
)
Creates an instance of this client using the provided credentials file.
filename
str
The path to the service account private key json file.
IDSClient
get_endpoint
get_endpoint
(
request
:
Optional
[
Union
[
google
.
cloud
.
ids_v1
.
types
.
ids
.
GetEndpointRequest
,
dict
]]
=
None
,
*
,
name
:
Optional
[
str
]
=
None
,
retry
:
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Gets details of a single Endpoint.
from google.cloud import ids_v1
def sample_get_endpoint():
# Create a client
client = ids_v1
. IDSClient
()
# Initialize request argument(s)
request = ids_v1
. GetEndpointRequest
(
name="name_value",
)
# Make the request
response = client. get_endpoint
(request=request)
# Handle the response
print(response)
request
name
str
Required. The name of the endpoint to retrieve. Format: projects/{project}/locations/{location}/endpoints/{endpoint}
This corresponds to the name
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
get_mtls_endpoint_and_cert_source
get_mtls_endpoint_and_cert_source
(
client_options
:
Optional
[
google
.
api_core
.
client_options
.
ClientOptions
]
=
None
,
)
Return the API endpoint and client cert source for mutual TLS.
The client cert source is determined in the following order:
(1) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is not "true", the
client cert source is None.
(2) if client_options.client_cert_source
is provided, use the provided one; if the
default client cert source exists, use the default one; otherwise the client cert
source is None.
The API endpoint is determined in the following order:
(1) if client_options.api_endpoint
if provided, use the provided one.
(2) if GOOGLE_API_USE_CLIENT_CERTIFICATE
environment variable is "always", use the
default mTLS endpoint; if the environment variabel is "never", use the default API
endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise
use the default API endpoint.
More details can be found at https://google.aip.dev/auth/4114 .
client_options
google.api_core.client_options.ClientOptions
Custom options for the client. Only the api_endpoint
and client_cert_source
properties may be used in this method.
google.auth.exceptions.MutualTLSChannelError
Tuple[str, Callable[[], Tuple[bytes, bytes]]]
list_endpoints
list_endpoints
(
request
:
Optional
[
Union
[
google
.
cloud
.
ids_v1
.
types
.
ids
.
ListEndpointsRequest
,
dict
]]
=
None
,
*
,
parent
:
Optional
[
str
]
=
None
,
retry
:
Union
[
google
.
api_core
.
retry
.
Retry
,
google
.
api_core
.
gapic_v1
.
method
.
_MethodDefault
]
=
< _MethodDefault
.
_DEFAULT_VALUE
:
< object
object
>> ,
timeout
:
Optional
[
float
]
=
None
,
metadata
:
Sequence
[
Tuple
[
str
,
str
]]
=
())
Lists Endpoints in a given project and location.
from google.cloud import ids_v1
def sample_list_endpoints():
# Create a client
client = ids_v1
. IDSClient
()
# Initialize request argument(s)
request = ids_v1
. ListEndpointsRequest
(
parent="parent_value",
)
# Make the request
page_result = client. list_endpoints
(request=request)
# Handle the response
for response in page_result:
print(response)
request
parent
str
Required. The parent, which owns this collection of endpoints. This corresponds to the parent
field on the request
instance; if request
is provided, this should not be set.
retry
google.api_core.retry.Retry
Designation of what errors, if any, should be retried.
timeout
float
The timeout for this request.
metadata
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata.
parse_common_billing_account_path
parse_common_billing_account_path
(
path
:
str
)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path
(
path
:
str
)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path
(
path
:
str
)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path
(
path
:
str
)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path
(
path
:
str
)
Parse a project path into its component segments.
parse_endpoint_path
parse_endpoint_path
(
path
:
str
)
Parses a endpoint path into its component segments.
