Struct AddGoLinkRequest

pub struct AddGoLinkRequest {
    pub creator_email: Option<AddGoLinkRequestCreatorEmail>,
    pub description: Option<AddGoLinkRequestDescription>,
    pub destination_url: AddGoLinkRequestDestinationUrl,
    pub name: AddGoLinkRequestName,
    pub url_pattern: Option<AddGoLinkRequestUrlPattern>,
}

Payload for creating a Go Link

JSON schema

{
 "description": "Payload for creating a Go Link",
 "type": "object",
 "required": [
   "destinationUrl",
   "name"
 ],
 "properties": {
   "creatorEmail": {
     "description": "Optional creator email for the Go Link. Only
organization admins can set this field.",
     "examples": [
       "foo@bar.com"
     ],
     "type": [
       "string",
       "null"
     ],
     "maxLength": 512
   },
   "description": {
     "description": "Optional description for the Go Link.",
     "type": "string",
     "maxLength": 512
   },
   "destinationUrl": {
     "description": "The URL that the Go Link redirects to.",
     "type": "string",
     "maxLength": 2048
   },
   "name": {
     "description": "The name of the Go Link that comes after go/. Only
alphanumeric characters, dashes, and underscores are allowed.",
     "type": "string",
     "maxLength": 128,
     "pattern": "^[a-zA-Z0-9\\-_]+$"
   },
   "urlPattern": {
     "description": "Optional destination URL with {*} placeholders for
variables to be inserted. Variables are specified like
go/<name>/<var1>/<var2>.",
     "examples": [
       "https://example.com/{*}/{*}"
     ],
     "type": [
       "string",
       "null"
     ],
     "maxLength": 2048
   }
 },
 "additionalProperties": false,
 "x-schema-name": "AddGoLinkRequest"
}

Fields

creator_email: Option<AddGoLinkRequestCreatorEmail>

Optional creator email for the Go Link. Only organization admins can set this field.

description: Option<AddGoLinkRequestDescription>

Optional description for the Go Link.

destination_url: AddGoLinkRequestDestinationUrl

The URL that the Go Link redirects to.

name: AddGoLinkRequestName

The name of the Go Link that comes after go/. Only alphanumeric characters, dashes, and underscores are allowed.

url_pattern: Option<AddGoLinkRequestUrlPattern>

Optional destination URL with {*} placeholders for variables to be inserted. Variables are specified like go///.

Trait Implementations

impl Clone for AddGoLinkRequest

fn clone(&self) -> AddGoLinkRequest

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AddGoLinkRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AddGoLinkRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AddGoLinkRequest> for AddGoLinkRequest

fn from(value: &AddGoLinkRequest) -> Self

Converts to this type from the input type.

impl Serialize for AddGoLinkRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.