Class RegistrationServiceAsyncClient (0.4.1) 

RegistrationServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.servicedirectory_v1.services.registration_service.transports.base.RegistrationServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-service-directory/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = 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/*.

Properties

transport

Return the transport used by the client instance.

Returns
Type Description
RegistrationServiceTransport The transport used by the client instance.

Methods

RegistrationServiceAsyncClient

RegistrationServiceAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.servicedirectory_v1.services.registration_service.transports.base.RegistrationServiceTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-service-directory/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiate 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 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.
Exceptions
Type Description
google.auth.exceptions.MutualTlsChannelError If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Return a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Return a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Return a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Return a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Return a fully-qualified project string.

create_endpoint

create_endpoint(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.CreateEndpointRequest] = None, *, parent: Optional[str] = None, endpoint: Optional[google.cloud.servicedirectory_v1.types.endpoint.Endpoint] = None, endpoint_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a endpoint, and returns the new Endpoint.

Parameters
Name Description
request .registration_service.CreateEndpointRequest

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 .gcs_endpoint.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? 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
.gcs_endpoint.Endpoint An individual endpoint that provides a service. The service must already exist to create an endpoint.

create_namespace

create_namespace(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.CreateNamespaceRequest] = None, *, parent: Optional[str] = None, namespace: Optional[google.cloud.servicedirectory_v1.types.namespace.Namespace] = None, namespace_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a namespace, and returns the new Namespace.

Parameters
Name Description
request .registration_service.CreateNamespaceRequest

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 .gcs_namespace.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? 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
.gcs_namespace.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[google.cloud.servicedirectory_v1.types.registration_service.CreateServiceRequest] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.servicedirectory_v1.types.service.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates a service, and returns the new Service.

Parameters
Name Description
request .registration_service.CreateServiceRequest

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 .gcs_service.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? 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
.gcs_service.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[google.cloud.servicedirectory_v1.types.registration_service.DeleteEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes a endpoint.

Parameters
Name Description
request .registration_service.DeleteEndpointRequest

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[google.cloud.servicedirectory_v1.types.registration_service.DeleteNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name Description
request .registration_service.DeleteNamespaceRequest

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[google.cloud.servicedirectory_v1.types.registration_service.DeleteServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_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.

Parameters
Name Description
request .registration_service.DeleteServiceRequest

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
)

Return 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
{@api.name} 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
{@api.name} The constructed client.

get_endpoint

get_endpoint(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.GetEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a endpoint.

Parameters
Name Description
request .registration_service.GetEndpointRequest

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
.endpoint.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[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_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).

Parameters
Name Description
request .iam_policy.GetIamPolicyRequest

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
.policy.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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')",="" }="" }="" ]="" }="" **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')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

get_namespace

get_namespace(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.GetNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a namespace.

Parameters
Name Description
request .registration_service.GetNamespaceRequest

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
.namespace.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[google.cloud.servicedirectory_v1.types.registration_service.GetServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets a service.

Parameters
Name Description
request .registration_service.GetServiceRequest

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
.service.Service An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.

get_transport_class

get_transport_class()

Return an appropriate transport class.

list_endpoints

list_endpoints(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.ListEndpointsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all endpoints.

Parameters
Name Description
request .registration_service.ListEndpointsRequest

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
.pagers.ListEndpointsAsyncPager The response message for RegistrationService.ListEndpoints. Iterating over this object will yield results and resolve additional pages automatically.

list_namespaces

list_namespaces(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.ListNamespacesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all namespaces.

Parameters
Name Description
request .registration_service.ListNamespacesRequest

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
.pagers.ListNamespacesAsyncPager The response message for RegistrationService.ListNamespaces. Iterating over this object will yield results and resolve additional pages automatically.

list_services

list_services(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.ListServicesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists all services belonging to a namespace.

Parameters
Name Description
request .registration_service.ListServicesRequest

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
.pagers.ListServicesAsyncPager 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)

Return 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)

Parse a endpoint path into its component segments.

parse_namespace_path

parse_namespace_path(path: str)

Parse a namespace path into its component segments.

parse_service_path

parse_service_path(path: str)

Parse a service path into its component segments.

service_path

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

Return a fully-qualified service string.

set_iam_policy

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_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).

Parameters
Name Description
request .iam_policy.SetIamPolicyRequest

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
.policy.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition, which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **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')",="" }="" }="" ]="" }="" **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')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the="">IAM developer's guide __.

test_iam_permissions

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

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

Parameters
Name Description
request .iam_policy.TestIamPermissionsRequest

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
.iam_policy.TestIamPermissionsResponse Response message for TestIamPermissions method.

update_endpoint

update_endpoint(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.UpdateEndpointRequest] = None, *, endpoint: Optional[google.cloud.servicedirectory_v1.types.endpoint.Endpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a endpoint.

Parameters
Name Description
request .registration_service.UpdateEndpointRequest

The request object. The request message for RegistrationService.UpdateEndpoint.
endpoint .gcs_endpoint.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 .field_mask.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
.gcs_endpoint.Endpoint An individual endpoint that provides a service. The service must already exist to create an endpoint.

update_namespace

update_namespace(request: Optional[google.cloud.servicedirectory_v1.types.registration_service.UpdateNamespaceRequest] = None, *, namespace: Optional[google.cloud.servicedirectory_v1.types.namespace.Namespace] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a namespace.

Parameters
Name Description
request .registration_service.UpdateNamespaceRequest

The request object. The request message for RegistrationService.UpdateNamespace.
namespace .gcs_namespace.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 .field_mask.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
.gcs_namespace.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[google.cloud.servicedirectory_v1.types.registration_service.UpdateServiceRequest] = None, *, service: Optional[google.cloud.servicedirectory_v1.types.service.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates a service.

Parameters
Name Description
request .registration_service.UpdateServiceRequest

The request object. The request message for RegistrationService.UpdateService.
service .gcs_service.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 .field_mask.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
.gcs_service.Service An individual service. A service contains a name and optional metadata. A service must exist before endpoints can be added to it.