remote_hosts_patch: Update some attributes of this Remote Host

View source: R/generated_client.R

remote_hosts_patchR Documentation

Update some attributes of this Remote Host

Description

Update some attributes of this Remote Host

Usage

remote_hosts_patch(
  id,
  name = NULL,
  type = NULL,
  url = NULL,
  description = NULL
)

Arguments

id

integer required. The ID of the remote host.

name

string optional. The human readable name for the remote host.

type

string optional. The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

url

string optional. The URL for the remote host.

description

string optional. The description of the remote host.

Value

A list containing the following elements:

id

integer, The ID of the remote host.

name

string, The human readable name for the remote host.

type

string, The type of remote host. One of: RemoteHostTypes::Bigquery, RemoteHostTypes::Bitbucket, RemoteHostTypes::GitSSH, RemoteHostTypes::Github, RemoteHostTypes::GoogleDoc, RemoteHostTypes::JDBC, RemoteHostTypes::Postgres, RemoteHostTypes::Redshift, RemoteHostTypes::S3Storage, and RemoteHostTypes::Salesforce

url

string, The URL for the remote host.

description

string, The description of the remote host.

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".

user

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

createdAt

string,

updatedAt

string,


civis documentation built on April 1, 2023, 12:01 a.m.