package fonoster.routr.connect.domains.v2beta1

Get desktop application:
View/edit binary Protocol Buffers messages

The Domains service definition

• rpc Create (CreateDomainRequest, Domain)

  domains.proto:31

  Create a new Domain

  message CreateDomainRequest

  domains.proto:77

  The request message for Domains.Create

  • string name = 1

    The name of the Domain

  • string domain_uri = 2

    The domain_uri of the Domain

  • string access_control_list_ref = 3

    Reference to the ACL to use for this Domain

  • repeated EgressPolicy egress_policies = 4

    The egress_policy of the Domain

  • optional google.protobuf.Struct extended = 5

    The extended attributes of the Domain

• rpc Update (UpdateDomainRequest, Domain)

  domains.proto:33

  Update an existing Domain

  message UpdateDomainRequest

  domains.proto:91

  The request message for Domains.Update

  • string ref = 1

    The unique identifier of the Domain

  • string name = 2

    The name of the Domain

  • string access_control_list_ref = 3

    Reference to the ACL to use for this Domain

  • repeated EgressPolicy egress_policies = 4

    The egress_policy of the Domain

  • optional google.protobuf.Struct extended = 5

    The extended attributes of the Domain

• rpc Get (GetDomainRequest, Domain)

  domains.proto:35

  Get an existing Domain

  message GetDomainRequest

  domains.proto:105

  The request message for Domains.Get

  • string ref = 1

    The unique identifier of the Domain

• rpc Delete (DeleteDomainRequest, google.protobuf.Empty)

  domains.proto:37

  Delete an existing Domain

  message DeleteDomainRequest

  domains.proto:111

  The request message for Domains.Delete

  • string ref = 1

    The unique identifier of the Domain

• rpc List (ListDomainRequest, ListDomainsResponse)

  domains.proto:39

  List all Domains

  message ListDomainRequest

  domains.proto:131

  The request message for Domains.List

  • int32 page_size = 1

    The maximum number of items in the list

  • string page_token = 2

    The next_page_token value returned from the previous request, if any

  message ListDomainsResponse

  domains.proto:140

  The response message for Domains.List

  • repeated Domain items = 1

    List of Domains

  • string next_page_token = 2

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

• rpc FindBy (FindByRequest, FindByResponse)

  domains.proto:41

  Find a Domain by field name and value

  message FindByRequest

  domains.proto:117

  The request message for Domains.FindBy

  • string field_name = 1

    The field name to search

  • string field_value = 2

    The value to search

  message FindByResponse

  domains.proto:125

  The response message for the Domains.FindBy method

  • repeated Domain items = 1

    The list of Domains

The message for the Domain resource

Used as response type in: Domains.Create, Domains.Get, Domains.Update

Used as field type in: agents.v2beta1.Agent, FindByResponse, ListDomainsResponse

• string api_version = 1

  The API version of the Domain

• string ref = 2

  The unique identifier of the Domain

• string name = 3

  The name of the Domain

• string domain_uri = 4

  The URI of the Domain

• int32 created_at = 5

  The date of creation of the Domain

• int32 updated_at = 6

  The date of the last update

• optional acl.v2beta1.AccessControlList access_control_list = 7

  The list of IP addresses that are allowed to access the Domain

• repeated EgressPolicy egress_policies = 8

  The egress_policy of the Domain

• optional google.protobuf.Struct extended = 9

  The extended attributes of the Domain

EgressPolicy defines the policy for egress traffic

Used in: CreateDomainRequest, Domain, UpdateDomainRequest

• string rule = 1

  The pattern to match

• string number_ref = 2

  Reference to the number to use for egress

• optional numbers.v2beta1.Number number = 3

  The egress Number