documentdefinition.go

// Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.

package components

// DocumentDefinition - Indexable document structure
type DocumentDefinition struct {
	// Document title, in plain text, if present. If not present, the title would be attempted to be extracted from the content.
	Title *string `json:"title,omitempty"`
	// Source filename, in plain text, for the document. May be used as a fallback title for the document, if the title is not provided and cannot be extracted from the content. Populate this if there is no explicit title for the document and the content is sourced from a file.
	Filename *string `json:"filename,omitempty"`
	// The container name for the content (Folder for example for file content).
	Container *string `json:"container,omitempty"`
	// This represents the datasource sepcific id of the container.
	ContainerDatasourceID *string `json:"containerDatasourceId,omitempty"`
	// This represents the object type of the container. It cannot have spaces or _
	ContainerObjectType *string `json:"containerObjectType,omitempty"`
	Datasource          string  `json:"datasource"`
	// The type of the document (Case, KnowledgeArticle for Salesforce for example). It cannot have spaces or _
	ObjectType *string `json:"objectType,omitempty"`
	// The permalink for viewing the document. **Note: viewURL is a required field for non-entity datasources, but not required if the datasource is used to push custom entities (ie. datasources where isEntityDatasource is false).**'
	//
	ViewURL *string `json:"viewURL,omitempty"`
	// The datasource specific id for the document. This field is case insensitive and should not be more than 200 characters in length. Note: id is a required field for datasources created after 1st March 2025
	//
	ID *string `json:"id,omitempty"`
	// Describes text content or base64 encoded binary content
	Summary *ContentDefinition `json:"summary,omitempty"`
	// Describes text content or base64 encoded binary content
	Body *ContentDefinition `json:"body,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	Author *UserReferenceDefinition `json:"author,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	Owner *UserReferenceDefinition `json:"owner,omitempty"`
	// describes the access control details of the document
	Permissions *DocumentPermissionsDefinition `json:"permissions,omitempty"`
	// The creation time, in epoch seconds.
	CreatedAt *int64 `json:"createdAt,omitempty"`
	// The last update time, in epoch seconds.
	UpdatedAt *int64 `json:"updatedAt,omitempty"`
	// Describes how a user is referenced in a document. The user can be referenced by email or by a datasource specific id.
	UpdatedBy *UserReferenceDefinition `json:"updatedBy,omitempty"`
	// Labels associated with the document.
	Tags []string `json:"tags,omitempty"`
	// describes the interactions on the document
	Interactions *DocumentInteractionsDefinition `json:"interactions,omitempty"`
	Status       *string                         `json:"status,omitempty"`
	// Additional variations of the URL that this document points to.
	AdditionalUrls []string `json:"additionalUrls,omitempty"`
	// Comments associated with the document.
	Comments []CommentDefinition `json:"comments,omitempty"`
	// Additional metadata properties of the document. These can surface as [facets and operators](https://developers.glean.com/indexing/datasource/custom-properties/operators_and_facets).
	CustomProperties []CustomProperty `json:"customProperties,omitempty"`
}

func (o *DocumentDefinition) GetTitle() *string {
	if o == nil {
		return nil
	}
	return o.Title
}

func (o *DocumentDefinition) GetFilename() *string {
	if o == nil {
		return nil
	}
	return o.Filename
}

func (o *DocumentDefinition) GetContainer() *string {
	if o == nil {
		return nil
	}
	return o.Container
}

func (o *DocumentDefinition) GetContainerDatasourceID() *string {
	if o == nil {
		return nil
	}
	return o.ContainerDatasourceID
}

func (o *DocumentDefinition) GetContainerObjectType() *string {
	if o == nil {
		return nil
	}
	return o.ContainerObjectType
}

func (o *DocumentDefinition) GetDatasource() string {
	if o == nil {
		return ""
	}
	return o.Datasource
}

func (o *DocumentDefinition) GetObjectType() *string {
	if o == nil {
		return nil
	}
	return o.ObjectType
}

func (o *DocumentDefinition) GetViewURL() *string {
	if o == nil {
		return nil
	}
	return o.ViewURL
}

func (o *DocumentDefinition) GetID() *string {
	if o == nil {
		return nil
	}
	return o.ID
}

func (o *DocumentDefinition) GetSummary() *ContentDefinition {
	if o == nil {
		return nil
	}
	return o.Summary
}

func (o *DocumentDefinition) GetBody() *ContentDefinition {
	if o == nil {
		return nil
	}
	return o.Body
}

func (o *DocumentDefinition) GetAuthor() *UserReferenceDefinition {
	if o == nil {
		return nil
	}
	return o.Author
}

func (o *DocumentDefinition) GetOwner() *UserReferenceDefinition {
	if o == nil {
		return nil
	}
	return o.Owner
}

func (o *DocumentDefinition) GetPermissions() *DocumentPermissionsDefinition {
	if o == nil {
		return nil
	}
	return o.Permissions
}

func (o *DocumentDefinition) GetCreatedAt() *int64 {
	if o == nil {
		return nil
	}
	return o.CreatedAt
}

func (o *DocumentDefinition) GetUpdatedAt() *int64 {
	if o == nil {
		return nil
	}
	return o.UpdatedAt
}

func (o *DocumentDefinition) GetUpdatedBy() *UserReferenceDefinition {
	if o == nil {
		return nil
	}
	return o.UpdatedBy
}

func (o *DocumentDefinition) GetTags() []string {
	if o == nil {
		return nil
	}
	return o.Tags
}

func (o *DocumentDefinition) GetInteractions() *DocumentInteractionsDefinition {
	if o == nil {
		return nil
	}
	return o.Interactions
}

func (o *DocumentDefinition) GetStatus() *string {
	if o == nil {
		return nil
	}
	return o.Status
}

func (o *DocumentDefinition) GetAdditionalUrls() []string {
	if o == nil {
		return nil
	}
	return o.AdditionalUrls
}

func (o *DocumentDefinition) GetComments() []CommentDefinition {
	if o == nil {
		return nil
	}
	return o.Comments
}

func (o *DocumentDefinition) GetCustomProperties() []CustomProperty {
	if o == nil {
		return nil
	}
	return o.CustomProperties
}