Service Directory API . projects . locations . namespaces . services . endpoints

Instance Methods

create(parent, body=None, endpointId=None, x__xgafv=None)

Creates a endpoint, and returns the new Endpoint.

delete(name, x__xgafv=None)

Deletes a endpoint.

get(name, x__xgafv=None)

Gets a endpoint.

list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)

Lists all endpoints.

list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a endpoint.

Method Details

create(parent, body=None, endpointId=None, x__xgafv=None)
Creates a endpoint, and returns the new Endpoint.

Args:
  parent: string, Required. The resource name of the service that this endpoint provides. (required)
  body: object, The request body.
    The object takes the form of:

{ # An individual endpoint that provides a
    # service. The service must
    # already exist to create an endpoint.
  "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.
    "a_key": "A String",
  },
  "address": "A String", # 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.
  "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
  "name": "A String", # Immutable. The resource name for the endpoint in the format
      # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
}

  endpointId: string, Required. The Resource ID must be 1-63 characters long, and comply with
<a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An individual endpoint that provides a
      # service. The service must
      # already exist to create an endpoint.
    "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.
      "a_key": "A String",
    },
    "address": "A String", # 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.
    "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
    "name": "A String", # Immutable. The resource name for the endpoint in the format
        # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
  }
delete(name, x__xgafv=None)
Deletes a endpoint.

Args:
  name: string, Required. The name of the endpoint to delete. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated
      # empty messages in your APIs. A typical example is to use it as the request
      # or the response type of an API method. For instance:
      #
      #     service Foo {
      #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
      #     }
      #
      # The JSON representation for `Empty` is empty JSON object `{}`.
  }
get(name, x__xgafv=None)
Gets a endpoint.

Args:
  name: string, Required. The name of the endpoint to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An individual endpoint that provides a
      # service. The service must
      # already exist to create an endpoint.
    "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.
      "a_key": "A String",
    },
    "address": "A String", # 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.
    "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
    "name": "A String", # Immutable. The resource name for the endpoint in the format
        # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
  }
list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)
Lists all endpoints.

Args:
  parent: string, Required. The resource name of the service whose endpoints we'd like to
list. (required)
  filter: string, Optional. The filter to list result by.

General filter string syntax:
<field> <operator> <value> (<logical connector>)
<field> can be "name", "address", "port" or "metadata.<key>" for map field.
<operator> can be "<, >, <=, >=, !=, =, :". Of which ":" means HAS, and
is roughly the same as "=".
<value> must be the same data type as field.
<logical connector> 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.
  pageToken: string, Optional. The next_page_token value returned from a previous List request,
if any.
  orderBy: string, Optional. The order to list result by.
  pageSize: integer, Optional. The maximum number of items to return.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response message for RegistrationService.ListEndpoints.
    "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no
        # more results in the list.
    "endpoints": [ # The list of endpoints.
      { # An individual endpoint that provides a
          # service. The service must
          # already exist to create an endpoint.
        "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.
          "a_key": "A String",
        },
        "address": "A String", # 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.
        "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
        "name": "A String", # Immutable. The resource name for the endpoint in the format
            # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
      },
    ],
  }
list_next(previous_request, previous_response)
Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates a endpoint.

Args:
  name: string, Immutable. The resource name for the endpoint in the format
'projects/*/locations/*/namespaces/*/services/*/endpoints/*'. (required)
  body: object, The request body.
    The object takes the form of:

{ # An individual endpoint that provides a
    # service. The service must
    # already exist to create an endpoint.
  "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.
    "a_key": "A String",
  },
  "address": "A String", # 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.
  "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
  "name": "A String", # Immutable. The resource name for the endpoint in the format
      # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
}

  updateMask: string, Required. List of fields to be updated in this request.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An individual endpoint that provides a
      # service. The service must
      # already exist to create an endpoint.
    "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.
      "a_key": "A String",
    },
    "address": "A String", # 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.
    "port": 42, # Optional. Service Directory will reject values outside of [0, 65535].
    "name": "A String", # Immutable. The resource name for the endpoint in the format
        # 'projects/*/locations/*/namespaces/*/services/*/endpoints/*'.
  }