package fonoster.routr.connect.peers.v2beta1

Get desktop application:
View/edit binary Protocol Buffers messages

The Peer service definition

• rpc Create (CreatePeerRequest, Peer)

  peers.proto:31

  Creates a new Peer

  message CreatePeerRequest

  peers.proto:91

  The request message for the Peers.Create method

  • string name = 1

    The name of the Peer

  • string username = 2

    The username of the Peer

  • string aor = 3

    The address of record of the Peer

  • string contact_addr = 4

    The contact address of the Peer

  • LoadBalancingAlgorithm balancing_algorithm = 5

    The load balancing algorithm of the Peer

  • bool with_session_affinity = 6

    The session affinity of the Peer

  • string access_control_list_ref = 7

    Reference to the ACL of the Peer

  • string credentials_ref = 8

    Reference to the Credentials of the Peer

  • bool enabled = 9

    The status of the Peer

  • int32 max_contacts = 11

    The maximum number of contacts that can be created for this Peer

  • int32 expires = 12

    Value to override the expires requested by the Peer

  • optional google.protobuf.Struct extended = 10

    The extended attributes of the Peer

• rpc Update (UpdatePeerRequest, Peer)

  peers.proto:33

  Updates an existing Peer

  message UpdatePeerRequest

  peers.proto:119

  The request message for the Peers.Update method

  • string ref = 1

    The unique identifier of the Peer

  • string name = 2

    The name of the Peer

  • string aor = 3

    The address of record of the Peer

  • string contact_addr = 4

    The contact address of the Peer

  • LoadBalancingAlgorithm balancing_algorithm = 5

    The load balancing algorithm of the Peer

  • bool with_session_affinity = 6

    The session affinity of the Peer

  • string access_control_list_ref = 7

    Reference to the ACL of the Peer

  • string credentials_ref = 8

    Reference to the Credentials of the Peer

  • bool enabled = 9

    The status of the Peer

  • int32 max_contacts = 11

    The maximum number of contacts that can be created for this Peer

  • int32 expires = 12

    Value to override the expires requested by the Peer

  • optional google.protobuf.Struct extended = 10

    The extended attributes of the Peer

• rpc Get (GetPeerRequest, Peer)

  peers.proto:35

  Gets an existing Peer

  message GetPeerRequest

  peers.proto:147

  The request message for the Peers.Get method

  • string ref = 1

    The unique identifier of the Peer

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

  peers.proto:37

  Deletes an existing Peer

  message DeletePeerRequest

  peers.proto:153

  The request message for the Peers.Delete method

  • string ref = 1

    The unique identifier of the Peer

• rpc List (ListPeersRequest, ListPeersResponse)

  peers.proto:39

  Lists all Peers

  message ListPeersRequest

  peers.proto:172

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

  peers.proto:180

  • repeated Peer items = 1

    List of Peers items

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

  peers.proto:41

  Find Agents by field name and value

  message FindByRequest

  peers.proto:159

  The request message for the Peers.FindBy method

  • string fieldName = 1

    The field name to search

  • string fieldValue = 2

    The value to search

  message FindByResponse

  peers.proto:167

  The response message for the Peers.FindBy method

  • repeated Peer items = 1

    The list of Peers items

Used in: CreatePeerRequest, Peer, UpdatePeerRequest

• UNSPECIFIED = 0

  Value for situations where the load balancing algorithm is not specified Such as having an aor starting with "sip:"

• ROUND_ROBIN = 1

  The round robin load balancing algorithm

• LEAST_SESSIONS = 2

  The least sessions load balancing algorithm

The message for the Peer resource

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

Used as field type in: FindByResponse, ListPeersResponse

• string api_version = 1

  The API version of the Peer

• string ref = 2

  The unique identifier of the Peer

• string name = 3

  The name of the Peer

• string username = 4

  The username of the Peer

• string aor = 5

  The address of record of the Peer

• string contact_addr = 6

  The contact address of the Peer

• LoadBalancingAlgorithm balancing_algorithm = 7

  The load balancing algorithm of the Peer

• bool with_session_affinity = 8

  The session affinity of the Peer

• bool enabled = 9

  The status of the Peer

• int32 created_at = 10

  The date and time when the Peer was created

• int32 updated_at = 11

  The date and time when the Peer was last updated

• optional acl.v2beta1.AccessControlList access_control_list = 12

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

• optional credentials.v2beta1.Credentials credentials = 13

  The credentials of the Peer

• int32 max_contacts = 15

  The maximum number of contacts that can be created for this Peer

• int32 expires = 16

  Value to override the expires requested by the Peer

• optional google.protobuf.Struct extended = 14

  The extended attributes of the Peer