mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 20:37:47 +00:00
starting point for go docs
This commit is contained in:
195
docs/tools/sdk/go/Reference/Beta/Models/CampaignReference.md
Normal file
195
docs/tools/sdk/go/Reference/Beta/Models/CampaignReference.md
Normal file
@@ -0,0 +1,195 @@
|
||||
---
|
||||
id: beta-campaign-reference
|
||||
title: CampaignReference
|
||||
pagination_label: CampaignReference
|
||||
sidebar_label: CampaignReference
|
||||
sidebar_class_name: gosdk
|
||||
keywords: ['go', 'Golang', 'sdk', 'CampaignReference', 'BetaCampaignReference']
|
||||
slug: /tools/sdk/go/beta/models/campaign-reference
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignReference', 'BetaCampaignReference']
|
||||
---
|
||||
|
||||
# CampaignReference
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **string** | The unique ID of the campaign. |
|
||||
**Name** | **string** | The name of the campaign. |
|
||||
**Type** | **string** | The type of object that is being referenced. |
|
||||
**CampaignType** | **string** | The type of the campaign. |
|
||||
**Description** | **NullableString** | The description of the campaign set by the admin who created it. |
|
||||
**CorrelatedStatus** | **string** | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). |
|
||||
**MandatoryCommentRequirement** | **string** | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. |
|
||||
|
||||
## Methods
|
||||
|
||||
### NewCampaignReference
|
||||
|
||||
`func NewCampaignReference(id string, name string, type_ string, campaignType string, description NullableString, correlatedStatus string, mandatoryCommentRequirement string, ) *CampaignReference`
|
||||
|
||||
NewCampaignReference instantiates a new CampaignReference object
|
||||
This constructor will assign default values to properties that have it defined,
|
||||
and makes sure properties required by API are set, but the set of arguments
|
||||
will change when the set of required properties is changed
|
||||
|
||||
### NewCampaignReferenceWithDefaults
|
||||
|
||||
`func NewCampaignReferenceWithDefaults() *CampaignReference`
|
||||
|
||||
NewCampaignReferenceWithDefaults instantiates a new CampaignReference object
|
||||
This constructor will only assign default values to properties that have it defined,
|
||||
but it doesn't guarantee that properties required by API are set
|
||||
|
||||
### GetId
|
||||
|
||||
`func (o *CampaignReference) GetId() string`
|
||||
|
||||
GetId returns the Id field if non-nil, zero value otherwise.
|
||||
|
||||
### GetIdOk
|
||||
|
||||
`func (o *CampaignReference) GetIdOk() (*string, bool)`
|
||||
|
||||
GetIdOk returns a tuple with the Id field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetId
|
||||
|
||||
`func (o *CampaignReference) SetId(v string)`
|
||||
|
||||
SetId sets Id field to given value.
|
||||
|
||||
|
||||
### GetName
|
||||
|
||||
`func (o *CampaignReference) GetName() string`
|
||||
|
||||
GetName returns the Name field if non-nil, zero value otherwise.
|
||||
|
||||
### GetNameOk
|
||||
|
||||
`func (o *CampaignReference) GetNameOk() (*string, bool)`
|
||||
|
||||
GetNameOk returns a tuple with the Name field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetName
|
||||
|
||||
`func (o *CampaignReference) SetName(v string)`
|
||||
|
||||
SetName sets Name field to given value.
|
||||
|
||||
|
||||
### GetType
|
||||
|
||||
`func (o *CampaignReference) GetType() string`
|
||||
|
||||
GetType returns the Type field if non-nil, zero value otherwise.
|
||||
|
||||
### GetTypeOk
|
||||
|
||||
`func (o *CampaignReference) GetTypeOk() (*string, bool)`
|
||||
|
||||
GetTypeOk returns a tuple with the Type field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetType
|
||||
|
||||
`func (o *CampaignReference) SetType(v string)`
|
||||
|
||||
SetType sets Type field to given value.
|
||||
|
||||
|
||||
### GetCampaignType
|
||||
|
||||
`func (o *CampaignReference) GetCampaignType() string`
|
||||
|
||||
GetCampaignType returns the CampaignType field if non-nil, zero value otherwise.
|
||||
|
||||
### GetCampaignTypeOk
|
||||
|
||||
`func (o *CampaignReference) GetCampaignTypeOk() (*string, bool)`
|
||||
|
||||
GetCampaignTypeOk returns a tuple with the CampaignType field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetCampaignType
|
||||
|
||||
`func (o *CampaignReference) SetCampaignType(v string)`
|
||||
|
||||
SetCampaignType sets CampaignType field to given value.
|
||||
|
||||
|
||||
### GetDescription
|
||||
|
||||
`func (o *CampaignReference) GetDescription() string`
|
||||
|
||||
GetDescription returns the Description field if non-nil, zero value otherwise.
|
||||
|
||||
### GetDescriptionOk
|
||||
|
||||
`func (o *CampaignReference) GetDescriptionOk() (*string, bool)`
|
||||
|
||||
GetDescriptionOk returns a tuple with the Description field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetDescription
|
||||
|
||||
`func (o *CampaignReference) SetDescription(v string)`
|
||||
|
||||
SetDescription sets Description field to given value.
|
||||
|
||||
|
||||
### SetDescriptionNil
|
||||
|
||||
`func (o *CampaignReference) SetDescriptionNil(b bool)`
|
||||
|
||||
SetDescriptionNil sets the value for Description to be an explicit nil
|
||||
|
||||
### UnsetDescription
|
||||
`func (o *CampaignReference) UnsetDescription()`
|
||||
|
||||
UnsetDescription ensures that no value is present for Description, not even an explicit nil
|
||||
### GetCorrelatedStatus
|
||||
|
||||
`func (o *CampaignReference) GetCorrelatedStatus() string`
|
||||
|
||||
GetCorrelatedStatus returns the CorrelatedStatus field if non-nil, zero value otherwise.
|
||||
|
||||
### GetCorrelatedStatusOk
|
||||
|
||||
`func (o *CampaignReference) GetCorrelatedStatusOk() (*string, bool)`
|
||||
|
||||
GetCorrelatedStatusOk returns a tuple with the CorrelatedStatus field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetCorrelatedStatus
|
||||
|
||||
`func (o *CampaignReference) SetCorrelatedStatus(v string)`
|
||||
|
||||
SetCorrelatedStatus sets CorrelatedStatus field to given value.
|
||||
|
||||
|
||||
### GetMandatoryCommentRequirement
|
||||
|
||||
`func (o *CampaignReference) GetMandatoryCommentRequirement() string`
|
||||
|
||||
GetMandatoryCommentRequirement returns the MandatoryCommentRequirement field if non-nil, zero value otherwise.
|
||||
|
||||
### GetMandatoryCommentRequirementOk
|
||||
|
||||
`func (o *CampaignReference) GetMandatoryCommentRequirementOk() (*string, bool)`
|
||||
|
||||
GetMandatoryCommentRequirementOk returns a tuple with the MandatoryCommentRequirement field if it's non-nil, zero value otherwise
|
||||
and a boolean to check if the value has been set.
|
||||
|
||||
### SetMandatoryCommentRequirement
|
||||
|
||||
`func (o *CampaignReference) SetMandatoryCommentRequirement(v string)`
|
||||
|
||||
SetMandatoryCommentRequirement sets MandatoryCommentRequirement field to given value.
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user