meshes

Creates, updates, deletes, gets or lists a meshes resource.

Overview

Name	meshes
Type	Resource
Id	google.networkservices.meshes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the Mesh resource. It matches pattern projects/*/locations/global/meshes/.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
envoyHeaders	string	Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
interceptionPort	integer (int32)	Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments.
labels	object	Optional. Set of label tags associated with the Mesh resource.
selfLink	string	Output only. Server-defined URL of this resource
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the Mesh resource. It matches pattern projects/*/locations/global/meshes/.
createTime	string (google-datetime)	Output only. The timestamp when the resource was created.
description	string	Optional. A free-text description of the resource. Max length 1024 characters.
envoyHeaders	string	Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
interceptionPort	integer (int32)	Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments.
labels	object	Optional. Set of label tags associated with the Mesh resource.
selfLink	string	Output only. Server-defined URL of this resource
updateTime	string (google-datetime)	Output only. The timestamp when the resource was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, meshesId		Gets details of a single Mesh.
list	select	projectsId, locationsId	pageSize, pageToken, returnPartialSuccess	Lists Meshes in a given project and location.
create	insert	projectsId, locationsId	meshId	Creates a new Mesh in a given project and location.
patch	update	projectsId, locationsId, meshesId	updateMask	Updates the parameters of a single Mesh.
delete	delete	projectsId, locationsId, meshesId		Deletes a single Mesh.

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
locationsId	string
meshesId	string
projectsId	string
meshId	string
pageSize	integer (int32)
pageToken	string
returnPartialSuccess	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single Mesh.

SELECT
name,
createTime,
description,
envoyHeaders,
interceptionPort,
labels,
selfLink,
updateTime
FROM google.networkservices.meshes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND meshesId = '{{ meshesId }}' -- required;

list

Lists Meshes in a given project and location.

SELECT
name,
createTime,
description,
envoyHeaders,
interceptionPort,
labels,
selfLink,
updateTime
FROM google.networkservices.meshes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}';

INSERT examples

create

Creates a new Mesh in a given project and location.

INSERT INTO google.networkservices.meshes (
data__name,
data__labels,
data__description,
data__interceptionPort,
data__envoyHeaders,
projectsId,
locationsId,
meshId
)
SELECT 
'{{ name }}',
'{{ labels }}',
'{{ description }}',
{{ interceptionPort }},
'{{ envoyHeaders }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ meshId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: meshes
  props:
    - name: projectsId
      value: string
      description: Required parameter for the meshes resource.
    - name: locationsId
      value: string
      description: Required parameter for the meshes resource.
    - name: name
      value: string
      description: >
        Identifier. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`.
        
    - name: labels
      value: object
      description: >
        Optional. Set of label tags associated with the Mesh resource.
        
    - name: description
      value: string
      description: >
        Optional. A free-text description of the resource. Max length 1024 characters.
        
    - name: interceptionPort
      value: integer
      description: >
        Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments.
        
    - name: envoyHeaders
      value: string
      description: >
        Optional. Determines if envoy will insert internal debug headers into upstream requests. Other Envoy headers may still be injected. By default, envoy will not insert any debug headers.
        
      valid_values: ['ENVOY_HEADERS_UNSPECIFIED', 'NONE', 'DEBUG_HEADERS']
    - name: meshId
      value: string

UPDATE examples

patch

Updates the parameters of a single Mesh.

UPDATE google.networkservices.meshes
SET 
data__name = '{{ name }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__interceptionPort = {{ interceptionPort }},
data__envoyHeaders = '{{ envoyHeaders }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND meshesId = '{{ meshesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single Mesh.

DELETE FROM google.networkservices.meshes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND meshesId = '{{ meshesId }}' --required;