endpoints

Creates, updates, deletes, gets or lists an endpoints resource.

Overview

Name	endpoints
Type	Resource
Id	google.servicedirectory.endpoints

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
address	string	Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: * 8.8.8 * 8.8.8.8:53 * test:bad:address * [::1] * [::1]:8080 Limited to 45 characters.
annotations	object	Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the metadata field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.
network	string	Immutable. The Google Compute Engine network (VPC) of the endpoint in the format projects//locations/global/networks/*. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
port	integer (int32)	Optional. Service Directory rejects values outside of [0, 65535].
uid	string	Output only. The globally unique identifier of the endpoint in the UUID4 format.

list

Successful response

Name	Datatype	Description
name	string	Immutable. The resource name for the endpoint in the format projects/*/locations/*/namespaces/*/services/*/endpoints/*.
address	string	Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: * 8.8.8 * 8.8.8.8:53 * test:bad:address * [::1] * [::1]:8080 Limited to 45 characters.
annotations	object	Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the metadata field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.
network	string	Immutable. The Google Compute Engine network (VPC) of the endpoint in the format projects//locations/global/networks/*. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
port	integer (int32)	Optional. Service Directory rejects values outside of [0, 65535].
uid	string	Output only. The globally unique identifier of the endpoint in the UUID4 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, namespacesId, servicesId, endpointsId		Gets an endpoint.
list	select	projectsId, locationsId, namespacesId, servicesId	pageSize, pageToken, filter, orderBy	Lists all endpoints.
create	insert	projectsId, locationsId, namespacesId, servicesId	endpointId	Creates an endpoint, and returns the new endpoint.
patch	update	projectsId, locationsId, namespacesId, servicesId, endpointsId	updateMask	Updates an endpoint.
delete	delete	projectsId, locationsId, namespacesId, servicesId, endpointsId		Deletes an endpoint.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
endpointsId	string
locationsId	string
namespacesId	string
projectsId	string
servicesId	string
endpointId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets an endpoint.

SELECT
name,
address,
annotations,
network,
port,
uid
FROM google.servicedirectory.endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND namespacesId = '{{ namespacesId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND endpointsId = '{{ endpointsId }}' -- required;

list

Lists all endpoints.

SELECT
name,
address,
annotations,
network,
port,
uid
FROM google.servicedirectory.endpoints
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND namespacesId = '{{ namespacesId }}' -- required
AND servicesId = '{{ servicesId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates an endpoint, and returns the new endpoint.

INSERT INTO google.servicedirectory.endpoints (
data__name,
data__address,
data__port,
data__annotations,
data__network,
projectsId,
locationsId,
namespacesId,
servicesId,
endpointId
)
SELECT 
'{{ name }}',
'{{ address }}',
{{ port }},
'{{ annotations }}',
'{{ network }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ namespacesId }}',
'{{ servicesId }}',
'{{ endpointId }}'
RETURNING
name,
address,
annotations,
network,
port,
uid
;

Manifest

# Description fields are for documentation purposes
- name: endpoints
  props:
    - name: projectsId
      value: string
      description: Required parameter for the endpoints resource.
    - name: locationsId
      value: string
      description: Required parameter for the endpoints resource.
    - name: namespacesId
      value: string
      description: Required parameter for the endpoints resource.
    - name: servicesId
      value: string
      description: Required parameter for the endpoints resource.
    - name: name
      value: string
      description: >
        Immutable. The resource name for the endpoint in the format `projects/*/locations/*/namespaces/*/services/*/endpoints/*`.
        
    - name: address
      value: string
      description: >
        Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: * `8.8.8` * `8.8.8.8:53` * `test:bad:address` * `[::1]` * `[::1]:8080` Limited to 45 characters.
        
    - name: port
      value: integer
      description: >
        Optional. Service Directory rejects values outside of `[0, 65535]`.
        
    - name: annotations
      value: object
      description: >
        Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the `metadata` field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory.
        
    - name: network
      value: string
      description: >
        Immutable. The Google Compute Engine network (VPC) of the endpoint in the format `projects//locations/global/networks/*`. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified.
        
    - name: endpointId
      value: string

UPDATE examples

patch

Updates an endpoint.

UPDATE google.servicedirectory.endpoints
SET 
data__name = '{{ name }}',
data__address = '{{ address }}',
data__port = {{ port }},
data__annotations = '{{ annotations }}',
data__network = '{{ network }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND namespacesId = '{{ namespacesId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND endpointsId = '{{ endpointsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
address,
annotations,
network,
port,
uid;

DELETE examples

delete

Deletes an endpoint.

DELETE FROM google.servicedirectory.endpoints
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND namespacesId = '{{ namespacesId }}' --required
AND servicesId = '{{ servicesId }}' --required
AND endpointsId = '{{ endpointsId }}' --required;