Class RegistrationServiceClient (1.5.2)

RegistrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicedirectory_v1.services.registration_service.transports.base.RegistrationServiceTransport]] = 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>)

Service Directory API for registering services. It defines the following resource model:

The API has a collection of Namespace resources, named projects/*/locations/*/namespaces/*.
Each Namespace has a collection of Service resources, named projects/*/locations/*/namespaces/*/services/*.
Each Service has a collection of Endpoint resources, named projects/*/locations/*/namespaces/*/services/*/endpoints/*.

Inheritance

builtins.object > RegistrationServiceClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
RegistrationServiceTransport	The transport used by the client instance.

Methods

RegistrationServiceClient

RegistrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicedirectory_v1.services.registration_service.transports.base.RegistrationServiceTransport]] = 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 registration service client.

Parameters

Name	Description
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, RegistrationServiceTransport]` 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.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If mutual TLS transport creation failed for any reason.

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.servicedirectory_v1.types.registration_service.CreateEndpointRequest, dict]] = None, *, parent: Optional[str] = None, endpoint: Optional[google.cloud.servicedirectory_v1.types.endpoint.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 endpoint, and returns the new Endpoint.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_create_endpoint():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.CreateEndpointRequest(
        parent="parent_value",
        endpoint_id="endpoint_id_value",
    )

    # Make the request
    response = client.create_endpoint(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.CreateEndpointRequest, dict]` The request object. The request message for RegistrationService.CreateEndpoint.
parent	`str` Required. The resource name of the service that this endpoint provides. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
endpoint	`google.cloud.servicedirectory_v1.types.Endpoint` Required. A endpoint with initial fields set. This corresponds to the `endpoint` field on the `request` instance; if `request` is provided, this should not be set.
endpoint_id	`str` Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Endpoint	An individual endpoint that provides a service. The service must already exist to create an endpoint.

create_namespace

create_namespace(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.CreateNamespaceRequest, dict]] = None, *, parent: Optional[str] = None, namespace: Optional[google.cloud.servicedirectory_v1.types.namespace.Namespace] = None, namespace_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 namespace, and returns the new Namespace.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_create_namespace():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.CreateNamespaceRequest(
        parent="parent_value",
        namespace_id="namespace_id_value",
    )

    # Make the request
    response = client.create_namespace(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.CreateNamespaceRequest, dict]` The request object. The request message for RegistrationService.CreateNamespace.
parent	`str` Required. The resource name of the project and location the namespace will be created in. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
namespace	`google.cloud.servicedirectory_v1.types.Namespace` Required. A namespace with initial fields set. This corresponds to the `namespace` field on the `request` instance; if `request` is provided, this should not be set.
namespace_id	`str` Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This corresponds to the `namespace_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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Namespace	A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

create_service

create_service(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.CreateServiceRequest, dict]] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.servicedirectory_v1.types.service.Service] = None, service_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 service, and returns the new Service.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_create_service():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.CreateServiceRequest(
        parent="parent_value",
        service_id="service_id_value",
    )

    # Make the request
    response = client.create_service(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.CreateServiceRequest, dict]` The request object. The request message for RegistrationService.CreateService.
parent	`str` Required. The resource name of the namespace this service will belong to. This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
service	`google.cloud.servicedirectory_v1.types.Service` Required. A service with initial fields set. This corresponds to the `service` field on the `request` instance; if `request` is provided, this should not be set.
service_id	`str` Required. The Resource ID must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This corresponds to the `service_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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Service	An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

delete_endpoint

delete_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.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 endpoint.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_delete_endpoint():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.DeleteEndpointRequest(
        name="name_value",
    )

    # Make the request
    client.delete_endpoint(request=request)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.DeleteEndpointRequest, dict]` The request object. The request message for RegistrationService.DeleteEndpoint.
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.

delete_namespace

delete_namespace(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.DeleteNamespaceRequest, 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 namespace. This also deletes all services and endpoints in the namespace.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_delete_namespace():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.DeleteNamespaceRequest(
        name="name_value",
    )

    # Make the request
    client.delete_namespace(request=request)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.DeleteNamespaceRequest, dict]` The request object. The request message for RegistrationService.DeleteNamespace.
name	`str` Required. The name of the namespace 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.

delete_service

delete_service(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.DeleteServiceRequest, 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 service. This also deletes all endpoints associated with the service.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_delete_service():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.DeleteServiceRequest(
        name="name_value",
    )

    # Make the request
    client.delete_service(request=request)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.DeleteServiceRequest, dict]` The request object. The request message for RegistrationService.DeleteService.
name	`str` Required. The name of the service 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.

endpoint_path

endpoint_path(
    project: str, location: str, namespace: str, service: 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.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
RegistrationServiceClient	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
RegistrationServiceClient	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
RegistrationServiceClient	The constructed client.

get_endpoint

get_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.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 a endpoint.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_get_endpoint():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.GetEndpointRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_endpoint(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.GetEndpointRequest, dict]` The request object. The request message for RegistrationService.GetEndpoint. This should not be used to lookup endpoints at runtime. Instead, use the `resolve` method.
name	`str` Required. The name of the endpoint to get. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Endpoint	An individual endpoint that provides a service. The service must already exist to create an endpoint.

get_iam_policy

get_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]] = 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 the IAM Policy for a resource (namespace or service only).

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_get_iam_policy():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.GetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.get_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest, dict]` The request object. Request message for `GetIamPolicy` method.
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.

Returns

Type

Description

google.iam.v1.policy_pb2.Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](\ https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ],="" "etag":="" "bwwwja0yfja=", " version":="" 3="" }="" **yaml="" example:**="" bindings:="" -="" members:="" -="" user:\="" mike@example.com="" -="" group:\="" admins@example.com="" -="" domain:google.com="" -="" serviceaccount:\="" my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:\="" eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" etag:="" bwwwja0yfja="version:" 3="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="" [iam="" documentation](\="">

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.

Parameter

Name	Description
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.

Exceptions

Type	Description
google.auth.exceptions.MutualTLSChannelError	If any errors happen.

Returns

Type	Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]]	returns the API endpoint and the client cert source to use.

get_namespace

get_namespace(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.GetNamespaceRequest, 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 a namespace.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_get_namespace():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.GetNamespaceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_namespace(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.GetNamespaceRequest, dict]` The request object. The request message for RegistrationService.GetNamespace.
name	`str` Required. The name of the namespace to retrieve. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Namespace	A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

get_service

get_service(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.GetServiceRequest, 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 a service.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_get_service():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.GetServiceRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_service(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.GetServiceRequest, dict]` The request object. The request message for RegistrationService.GetService. This should not be used for looking up a service. Insead, use the `resolve` method as it will contain all endpoints and associated metadata.
name	`str` Required. The name of the service to get. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Service	An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

list_endpoints

list_endpoints(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.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 all endpoints.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_list_endpoints():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_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)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.ListEndpointsRequest, dict]` The request object. The request message for RegistrationService.ListEndpoints.
parent	`str` Required. The resource name of the service whose endpoints we'd like to list. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.services.registration_service.pagers.ListEndpointsPager	The response message for RegistrationService.ListEndpoints. Iterating over this object will yield results and resolve additional pages automatically.

list_namespaces

list_namespaces(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.ListNamespacesRequest, 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 all namespaces.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_list_namespaces():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.ListNamespacesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_namespaces(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.ListNamespacesRequest, dict]` The request object. The request message for RegistrationService.ListNamespaces.
parent	`str` Required. The resource name of the project and location whose namespaces we'd like to list. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.services.registration_service.pagers.ListNamespacesPager	The response message for RegistrationService.ListNamespaces. Iterating over this object will yield results and resolve additional pages automatically.

list_services

list_services(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.ListServicesRequest, 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 all services belonging to a namespace.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_list_services():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.ListServicesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_services(request=request)

    # Handle the response
    for response in page_result:
        print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.ListServicesRequest, dict]` The request object. The request message for RegistrationService.ListServices.
parent	`str` Required. The resource name of the namespace whose services we'd like to list. 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.services.registration_service.pagers.ListServicesPager	The response message for RegistrationService.ListServices. Iterating over this object will yield results and resolve additional pages automatically.

namespace_path

namespace_path(project: str, location: str, namespace: str)

Returns a fully-qualified namespace string.

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.

parse_namespace_path

parse_namespace_path(path: str)

Parses a namespace path into its component segments.

parse_service_path

parse_service_path(path: str)

Parses a service path into its component segments.

service_path

service_path(project: str, location: str, namespace: str, service: str)

Returns a fully-qualified service string.

set_iam_policy

set_iam_policy(request: Optional[Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]] = 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]] = ())

Sets the IAM Policy for a resource (namespace or service only).

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_set_iam_policy():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.SetIamPolicyRequest(
        resource="resource_value",
    )

    # Make the request
    response = client.set_iam_policy(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest, dict]` The request object. Request message for `SetIamPolicy` method.
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.

Returns

Type

Description

google.iam.v1.policy_pb2.Policy

test_iam_permissions

test_iam_permissions(request: Optional[Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]] = 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]] = ())

Tests IAM permissions for a resource (namespace or service only).

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1
from google.iam.v1 import iam_policy_pb2  # type: ignore

def sample_test_iam_permissions():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = iam_policy_pb2.TestIamPermissionsRequest(
        resource="resource_value",
        permissions=['permissions_value1', 'permissions_value2'],
    )

    # Make the request
    response = client.test_iam_permissions(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest, dict]` The request object. Request message for `TestIamPermissions` method.
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.

Returns

Type	Description
google.iam.v1.iam_policy_pb2.TestIamPermissionsResponse	Response message for TestIamPermissions method.

update_endpoint

update_endpoint(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.UpdateEndpointRequest, dict]] = None, *, endpoint: Optional[google.cloud.servicedirectory_v1.types.endpoint.Endpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())

Updates a endpoint.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_update_endpoint():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.UpdateEndpointRequest(
    )

    # Make the request
    response = client.update_endpoint(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.UpdateEndpointRequest, dict]` The request object. The request message for RegistrationService.UpdateEndpoint.
endpoint	`google.cloud.servicedirectory_v1.types.Endpoint` Required. The updated endpoint. This corresponds to the `endpoint` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. List of fields to be updated in this request. This corresponds to the `update_mask` 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Endpoint	An individual endpoint that provides a service. The service must already exist to create an endpoint.

update_namespace

update_namespace(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.UpdateNamespaceRequest, dict]] = None, *, namespace: Optional[google.cloud.servicedirectory_v1.types.namespace.Namespace] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())

Updates a namespace.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_update_namespace():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.UpdateNamespaceRequest(
    )

    # Make the request
    response = client.update_namespace(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.UpdateNamespaceRequest, dict]` The request object. The request message for RegistrationService.UpdateNamespace.
namespace	`google.cloud.servicedirectory_v1.types.Namespace` Required. The updated namespace. This corresponds to the `namespace` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. List of fields to be updated in this request. This corresponds to the `update_mask` 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Namespace	A container for services. Namespaces allow administrators to group services together and define permissions for a collection of services.

update_service

update_service(request: Optional[Union[google.cloud.servicedirectory_v1.types.registration_service.UpdateServiceRequest, dict]] = None, *, service: Optional[google.cloud.servicedirectory_v1.types.service.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = 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]] = ())

Updates a service.

# 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://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import servicedirectory_v1

def sample_update_service():
    # Create a client
    client = servicedirectory_v1.RegistrationServiceClient()

    # Initialize request argument(s)
    request = servicedirectory_v1.UpdateServiceRequest(
    )

    # Make the request
    response = client.update_service(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicedirectory_v1.types.UpdateServiceRequest, dict]` The request object. The request message for RegistrationService.UpdateService.
service	`google.cloud.servicedirectory_v1.types.Service` Required. The updated service. This corresponds to the `service` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` Required. List of fields to be updated in this request. This corresponds to the `update_mask` 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.

Returns

Type	Description
google.cloud.servicedirectory_v1.types.Service	An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.