Client for Google Cloud Servicedirectory API

class google.cloud.servicedirectory_v1beta1.CreateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.CreateEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateEndpoint].

parent()

Required. The resource name of the service that this endpoint provides.

• Type

  str

endpoint_id()

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.

• Type

  str

endpoint()

Required. A endpoint with initial fields set.

• Type

  Endpoint

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.CreateNamespaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.CreateNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateNamespace].

parent()

Required. The resource name of the project and location the namespace will be created in.

• Type

  str

namespace_id()

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.

• Type

  str

namespace()

Required. A namespace with initial fields set.

• Type

  Namespace

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.CreateServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.CreateService][google.cloud.servicedirectory.v1beta1.RegistrationService.CreateService].

parent()

Required. The resource name of the namespace this service will belong to.

• Type

  str

service_id()

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.

• Type

  str

service()

Required. A service with initial fields set.

• Type

  Service

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.DeleteEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.DeleteEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteEndpoint].

name()

Required. The name of the endpoint to delete.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.DeleteNamespaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.DeleteNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteNamespace].

name()

Required. The name of the namespace to delete.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.DeleteServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.DeleteService][google.cloud.servicedirectory.v1beta1.RegistrationService.DeleteService].

name()

Required. The name of the service to delete.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.Endpoint(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An individual endpoint that provides a [service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

name()

Immutable. The resource name for the endpoint in the format projects/\*/locations/\*/namespaces/\*/services/\*/endpoints/\*

• Type

  str

address()

Optional. An IPv4 or IPv6 address. Service Directory will reject bad addresses like: “8.8.8” “8.8.8.8:53” “test:bad:address” “[::1]” “[::1]:8080” Limited to 45 characters.

• Type

  str

port()

Optional. Service Directory will reject values outside of [0, 65535].

• Type

  int

metadata()

Optional. Metadata for the endpoint. This data can be consumed by service clients. The entire metadata dictionary may contain up to 512 characters, spread accoss all key-value pairs. Metadata that goes beyond any these limits will be rejected.

• Type

  Sequence[MetadataEntry]

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.GetEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.GetEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.GetEndpoint]. This should not be used to lookup endpoints at runtime. Instead, use the resolve method.

name()

Required. The name of the endpoint to get.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.GetNamespaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.GetNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.GetNamespace].

name()

Required. The name of the namespace to retrieve.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.GetServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.GetService][google.cloud.servicedirectory.v1beta1.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()

Required. The name of the service to get.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListEndpointsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

parent()

Required. The resource name of the service whose endpoints we’d like to list.

• Type

  str

page_size()

Optional. The maximum number of items to return.

• Type

  int

page_token()

Optional. The next_page_token value returned from a previous List request, if any.

• Type

  str

filter()

Optional. The filter to list result by.

General filter string syntax: () can be “name”, “address”, “port” or “metadata.” for map field. can be “<, >, <=, >=, !=, =, :”. Of which “:” means HAS, and is roughly the same as “=”. must be the same data type as field. can be “AND, OR, NOT”.

Examples of valid filters:

• “metadata.owner” returns Endpoints that have a label with the key “owner” this is the same as “metadata:owner”.

• “metadata.protocol=gRPC” returns Endpoints that have key/value “protocol=gRPC”.

• “address=192.108.1.105” returns Endpoints that have this address.

• “port>8080” returns Endpoints that have port number larger than 8080.

• “name>projects/my-project/locations/us-east/namespaces/my-namespace/services/my-service/endpoints/endpoint-c” returns Endpoints that have name that is alphabetically later than the string, so “endpoint-e” will be returned but “endpoint-a” will not be.

• “metadata.owner!=sd AND metadata.foo=bar” returns Endpoints that have “owner” in label key but value is not “sd” AND have key/value foo=bar.

• “doesnotexist.foo=bar” returns an empty list. Note that Endpoint doesn’t have a field called “doesnotexist”. Since the filter does not match any Endpoints, it returns no results.

• Type

  str

order_by()

Optional. The order to list result by.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListEndpointsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The response message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

endpoints()

The list of endpoints.

• Type

  Sequence[Endpoint]

next_page_token()

Token to retrieve the next page of results, or empty if there are no more results in the list.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListNamespacesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

parent()

Required. The resource name of the project and location whose namespaces we’d like to list.

• Type

  str

page_size()

Optional. The maximum number of items to return.

• Type

  int

page_token()

Optional. The next_page_token value returned from a previous List request, if any.

• Type

  str

filter()

Optional. The filter to list result by.

General filter string syntax: () can be “name”, or “labels.” for map field. can be “<, >, <=, >=, !=, =, :”. Of which “:” means HAS, and is roughly the same as “=”. must be the same data type as field. can be “AND, OR, NOT”.

Examples of valid filters:

• “labels.owner” returns Namespaces that have a label with the key “owner” this is the same as “labels:owner”.

• “labels.protocol=gRPC” returns Namespaces that have key/value “protocol=gRPC”.

• “name>projects/my-project/locations/us-east/namespaces/namespace-c” returns Namespaces that have name that is alphabetically later than the string, so “namespace-e” will be returned but “namespace-a” will not be.

• “labels.owner!=sd AND labels.foo=bar” returns Namespaces that have “owner” in label key but value is not “sd” AND have key/value foo=bar.

• “doesnotexist.foo=bar” returns an empty list. Note that Namespace doesn’t have a field called “doesnotexist”. Since the filter does not match any Namespaces, it returns no results.

• Type

  str

order_by()

Optional. The order to list result by.

General order by string syntax: (<asc|desc>) (,) allows values {“name”} <asc/desc> ascending or descending order by . If this is left blank, “asc” is used. Note that an empty order_by string result in default order, which is order by name in ascending order.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListNamespacesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The response message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

namespaces()

The list of namespaces.

• Type

  Sequence[Namespace]

next_page_token()

Token to retrieve the next page of results, or empty if there are no more results in the list.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListServicesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

parent()

Required. The resource name of the namespace whose services we’d like to list.

• Type

  str

page_size()

Optional. The maximum number of items to return.

• Type

  int

page_token()

Optional. The next_page_token value returned from a previous List request, if any.

• Type

  str

filter()

Optional. The filter to list result by.

General filter string syntax: () can be “name”, or “metadata.” for map field. can be “<, >, <=, >=, !=, =, :”. Of which “:” means HAS, and is roughly the same as “=”. must be the same data type as field. can be “AND, OR, NOT”.

Examples of valid filters:

• “metadata.owner” returns Services that have a label with the key “owner” this is the same as “metadata:owner”.

• “metadata.protocol=gRPC” returns Services that have key/value “protocol=gRPC”.

• “name>projects/my-project/locations/us-east/namespaces/my-namespace/services/service-c” returns Services that have name that is alphabetically later than the string, so “service-e” will be returned but “service-a” will not be.

• “metadata.owner!=sd AND metadata.foo=bar” returns Services that have “owner” in label key but value is not “sd” AND have key/value foo=bar.

• “doesnotexist.foo=bar” returns an empty list. Note that Service doesn’t have a field called “doesnotexist”. Since the filter does not match any Services, it returns no results.

• Type

  str

order_by()

Optional. The order to list result by.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ListServicesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The response message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

services()

The list of services.

• Type

  Sequence[Service]

next_page_token()

Token to retrieve the next page of results, or empty if there are no more results in the list.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.LookupServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicedirectory_v1beta1.services.lookup_service.transports.base.LookupServiceTransport]] = None, 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'> = ClientOptions: {'api_endpoint': 'servicedirectory.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

Service Directory API for looking up service data at runtime.

Instantiate the lookup service client.

• Parameters

  • 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 , **LookupServiceTransport ] ) – The transport to use. If set to None, a transport is chosen automatically.

  • client_options( ClientOptions ) – Custom options for the client.

classmethod from_service_account_file(filename: str , *args, **kwargs)

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

• Parameters

  • filename( str ) – The path to the service account private key json file.

  • args– Additional arguments to pass to the constructor.

  • kwargs– Additional arguments to pass to the constructor.

• Returns

  The constructed client.

• Return type

  {@api.name }

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

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

• Parameters

  • filename( str ) – The path to the service account private key json file.

  • args– Additional arguments to pass to the constructor.

  • kwargs– Additional arguments to pass to the constructor.

• Returns

  The constructed client.

• Return type

  {@api.name }

resolve_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.lookup_service.ResolveServiceRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Returns a [service][google.cloud.servicedirectory.v1beta1.Service] and its associated endpoints. Resolving a service is not considered an active developer method.

• Parameters

  • request( ResolveServiceRequest ) – The request object. The request message for [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService]. Looks up a service by its name, returns the service and its endpoints.

  • 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  The response message for [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].

• Return type

  ResolveServiceResponse

class google.cloud.servicedirectory_v1beta1.Namespace(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A container for [services][google.cloud.servicedirectory.v1beta1.Service]. Namespaces allow administrators to group services together and define permissions for a collection of services.

name()

Immutable. The resource name for the namespace in the format projects/\*/locations/\*/namespaces/\*

• Type

  str

labels()

Optional. Resource labels associated with this Namespace. No more than 64 user labels can be associated with a given resource. Label keys and values can be no longer than 63 characters.

• Type

  Sequence[LabelsEntry]

class LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.RegistrationServiceClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Optional[Union[str, google.cloud.servicedirectory_v1beta1.services.registration_service.transports.base.RegistrationServiceTransport]] = None, 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'> = ClientOptions: {'api_endpoint': 'servicedirectory.googleapis.com', 'client_cert_source': None, 'client_encrypted_cert_source': None, 'quota_project_id': None, 'credentials_file': None, 'scopes': None, 'api_key': None, 'api_audience': None})

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

• The API has a collection of [Namespace][google.cloud.servicedirectory.v1beta1.Namespace] resources, named projects/\*/locations/\*/namespaces/\* .

• Each Namespace has a collection of [Service][google.cloud.servicedirectory.v1beta1.Service] resources, named projects/\*/locations/\*/namespaces/\*/services/\* .

• Each Service has a collection of [Endpoint][google.cloud.servicedirectory.v1beta1.Endpoint] resources, named projects/\*/locations/\*/namespaces/\*/services/\*/endpoints/\* .

Instantiate the registration service client.

• Parameters

  • 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.

create_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateEndpointRequest] = None, *, parent: Optional[str] = None, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, endpoint_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Creates a endpoint, and returns the new Endpoint.

• Parameters

  • request( CreateEndpointRequest ) – The request object. The request message for [RegistrationService.CreateEndpoint][google.cloud.servicedirectory.v1beta1.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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual endpoint that provides a [service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

• Return type

  Endpoint

create_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateNamespaceRequest] = None, *, parent: Optional[str] = None, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, namespace_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Creates a namespace, and returns the new Namespace.

• Parameters

  • request( CreateNamespaceRequest ) – The request object. The request message for [RegistrationService.CreateNamespace][google.cloud.servicedirectory.v1beta1.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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  A container for [services][google.cloud.servicedirectory.v1beta1.Service]. Namespaces allow administrators to group services together and define permissions for a collection of services.

• Return type

  Namespace

create_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.CreateServiceRequest] = None, *, parent: Optional[str] = None, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, service_id: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Creates a service, and returns the new Service.

• Parameters

  • request( CreateServiceRequest ) – The request object. The request message for [RegistrationService.CreateService][google.cloud.servicedirectory.v1beta1.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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual service. A service contains a name and optional metadata. A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

• Return type

  Service

delete_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Deletes a endpoint.

• Parameters

  • request( DeleteEndpointRequest ) – The request object. The request message for [RegistrationService.DeleteEndpoint][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

delete_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Deletes a namespace. This also deletes all services and endpoints in the namespace.

• Parameters

  • request( DeleteNamespaceRequest ) – The request object. The request message for [RegistrationService.DeleteNamespace][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

delete_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.DeleteServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Deletes a service. This also deletes all endpoints associated with the service.

• Parameters

  • request( DeleteServiceRequest ) – The request object. The request message for [RegistrationService.DeleteService][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

static endpoint_path(project: str , location: str , namespace: str , service: str , endpoint: str )

Return a fully-qualified endpoint string.

classmethod from_service_account_file(filename: str , *args, **kwargs)

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

• Parameters

  • filename( str ) – The path to the service account private key json file.

  • args– Additional arguments to pass to the constructor.

  • kwargs– Additional arguments to pass to the constructor.

• Returns

  The constructed client.

• Return type

  {@api.name }

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

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

• Parameters

  • filename( str ) – The path to the service account private key json file.

  • args– Additional arguments to pass to the constructor.

  • kwargs– Additional arguments to pass to the constructor.

• Returns

  The constructed client.

• Return type

  {@api.name }

get_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetEndpointRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Gets a endpoint.

• Parameters

  • request( GetEndpointRequest ) – The request object. The request message for [RegistrationService.GetEndpoint][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual endpoint that provides a [service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

• Return type

  Endpoint

get_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.GetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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

• Parameters

  • request( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

  A Policy consists of a list of bindings . A Binding binds a list of members to a role , where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.

  Example

   {
    "bindings": [
      {
        "role": "roles/owner",
        "members": [
          "user:mike@example.com",
          "group:admins@example.com",
          "domain:google.com",
          "serviceAccount:my-other-app@appspot.gserviceaccount.com",
        ]
      },
      {
        "role": "roles/viewer",
        "members": ["user:sean@example.com"]
      }
    ]
  } 
  

  For a description of IAM and its features, see the IAM developer’s guide .

• Return type

  Policy

get_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetNamespaceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Gets a namespace.

• Parameters

  • request( GetNamespaceRequest ) – The request object. The request message for [RegistrationService.GetNamespace][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  A container for [services][google.cloud.servicedirectory.v1beta1.Service]. Namespaces allow administrators to group services together and define permissions for a collection of services.

• Return type

  Namespace

get_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.GetServiceRequest] = None, *, name: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Gets a service.

• Parameters

  • request( GetServiceRequest ) – The request object. The request message for [RegistrationService.GetService][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual service. A service contains a name and optional metadata. A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

• Return type

  Service

list_endpoints(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListEndpointsRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Lists all endpoints.

• Parameters

  • request( ListEndpointsRequest ) – The request object. The request message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  The response message for [RegistrationService.ListEndpoints][google.cloud.servicedirectory.v1beta1.RegistrationService.ListEndpoints].

  Iterating over this object will yield results and resolve additional pages automatically.

• Return type

  ListEndpointsPager

list_namespaces(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListNamespacesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Lists all namespaces.

• Parameters

  • request( ListNamespacesRequest ) – The request object. The request message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  The response message for [RegistrationService.ListNamespaces][google.cloud.servicedirectory.v1beta1.RegistrationService.ListNamespaces].

  Iterating over this object will yield results and resolve additional pages automatically.

• Return type

  ListNamespacesPager

list_services(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.ListServicesRequest] = None, *, parent: Optional[str] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Lists all services belonging to a namespace.

• Parameters

  • request( ListServicesRequest ) – The request object. The request message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  The response message for [RegistrationService.ListServices][google.cloud.servicedirectory.v1beta1.RegistrationService.ListServices].

  Iterating over this object will yield results and resolve additional pages automatically.

• Return type

  ListServicesPager

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

Return a fully-qualified namespace string.

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

Return a fully-qualified service string.

set_iam_policy(request: Optional[google.iam.v1.iam_policy_pb2.SetIamPolicyRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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

• Parameters

  • request( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.

  A Policy consists of a list of bindings . A Binding binds a list of members to a role , where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.

  Example

   {
    "bindings": [
      {
        "role": "roles/owner",
        "members": [
          "user:mike@example.com",
          "group:admins@example.com",
          "domain:google.com",
          "serviceAccount:my-other-app@appspot.gserviceaccount.com",
        ]
      },
      {
        "role": "roles/viewer",
        "members": ["user:sean@example.com"]
      }
    ]
  } 
  

  For a description of IAM and its features, see the IAM developer’s guide .

• Return type

  Policy

test_iam_permissions(request: Optional[google.iam.v1.iam_policy_pb2.TestIamPermissionsRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

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

• Parameters

  • request( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  Response message for TestIamPermissions method.

• Return type

  TestIamPermissionsResponse

update_endpoint(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateEndpointRequest] = None, *, endpoint: Optional[google.cloud.servicedirectory_v1beta1.types.endpoint.Endpoint] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Updates a endpoint.

• Parameters

  • request( UpdateEndpointRequest ) – The request object. The request message for [RegistrationService.UpdateEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateEndpoint].

  • 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual endpoint that provides a [service][google.cloud.servicedirectory.v1beta1.Service]. The service must already exist to create an endpoint.

• Return type

  Endpoint

update_namespace(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateNamespaceRequest] = None, *, namespace: Optional[google.cloud.servicedirectory_v1beta1.types.namespace.Namespace] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Updates a namespace.

• Parameters

  • request( UpdateNamespaceRequest ) – The request object. The request message for [RegistrationService.UpdateNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateNamespace].

  • 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  A container for [services][google.cloud.servicedirectory.v1beta1.Service]. Namespaces allow administrators to group services together and define permissions for a collection of services.

• Return type

  Namespace

update_service(request: Optional[google.cloud.servicedirectory_v1beta1.types.registration_service.UpdateServiceRequest] = None, *, service: Optional[google.cloud.servicedirectory_v1beta1.types.service.Service] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE:

Updates a service.

• Parameters

  • request( UpdateServiceRequest ) – The request object. The request message for [RegistrationService.UpdateService][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateService].

  • 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( 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 ]( https://python.readthedocs.io/en/latest/library/stdtypes.html#str ) ] *] ) – Strings which should be sent along with the request as metadata.

• Returns

  An individual service. A service contains a name and optional metadata. A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

• Return type

  Service

class google.cloud.servicedirectory_v1beta1.ResolveServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService]. Looks up a service by its name, returns the service and its endpoints.

name()

Required. The name of the service to resolve.

• Type

  str

max_endpoints()

Optional. The maximum number of endpoints to return. Defaults to 25. Maximum is 100. If a value less than one is specified, the Default is used. If a value greater than the Maximum is specified, the Maximum is used.

• Type

  int

endpoint_filter()

Optional. The filter applied to the endpoints of the resolved service.

General filter string syntax: () can be “name” or “metadata.” for map field. can be “<, >, <=, >=, !=, =, :”. Of which “:” means HAS and is roughly the same as “=”. must be the same data type as the field. can be “AND, OR, NOT”.

Examples of valid filters:

• “metadata.owner” returns Endpoints that have a label with the key “owner”, this is the same as “metadata:owner”

• “metadata.protocol=gRPC” returns Endpoints that have key/value “protocol=gRPC”

• “metadata.owner!=sd AND metadata.foo=bar” returns Endpoints that have “owner” field in metadata with a value that is not “sd” AND have the key/value foo=bar.

• Type

  str

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.ResolveServiceResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The response message for [LookupService.ResolveService][google.cloud.servicedirectory.v1beta1.LookupService.ResolveService].

service()

• Type

  Service

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.Service(mapping=None, *, ignore_unknown_fields=False, **kwargs)

An individual service. A service contains a name and optional metadata. A service must exist before [endpoints][google.cloud.servicedirectory.v1beta1.Endpoint] can be added to it.

name()

Immutable. The resource name for the service in the format projects/\*/locations/\*/namespaces/\*/services/\*

• Type

  str

metadata()

Optional. Metadata for the service. This data can be consumed by service clients. The entire metadata dictionary may contain up to 2000 characters, spread across all key-value pairs. Metadata that goes beyond any these limits will be rejected.

• Type

  Sequence[MetadataEntry]

endpoints()

Output only. Endpoints associated with this service. Returned on LookupService.Resolve. Control plane clients should use RegistrationService.ListEndpoints.

• Type

  Sequence[Endpoint]

class MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.UpdateEndpointRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.UpdateEndpoint][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateEndpoint].

endpoint()

Required. The updated endpoint.

• Type

  Endpoint

update_mask()

Required. List of fields to be updated in this request.

• Type

  FieldMask

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.UpdateNamespaceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.UpdateNamespace][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateNamespace].

namespace()

Required. The updated namespace.

• Type

  Namespace

update_mask()

Required. List of fields to be updated in this request.

• Type

  FieldMask

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.

class google.cloud.servicedirectory_v1beta1.UpdateServiceRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request message for [RegistrationService.UpdateService][google.cloud.servicedirectory.v1beta1.RegistrationService.UpdateService].

service()

Required. The updated service.

• Type

  Service

update_mask()

Required. List of fields to be updated in this request.

• Type

  FieldMask

_ delattr_ (key)

Delete the value on the given field.

This is generally equivalent to setting a falsy value.

_ eq_ (other)

Return True if the messages are equal, False otherwise.

_ ne_ (other)

Return True if the messages are unequal, False otherwise.

_ setattr_ (key, value)

Set the value on the given field.

For well-known protocol buffer types which are marshalled, either the protocol buffer object or the Python equivalent is accepted.