codeenginev2

package
v0.0.0-...-a6e054a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 26, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package codeenginev2 : Operations and models for the CodeEngineV2 service

Index

Constants

View Source 
const (
	App_ManagedDomainMappings_Local        = "local"
	App_ManagedDomainMappings_LocalPrivate = "local_private"
	App_ManagedDomainMappings_LocalPublic  = "local_public"
)

Constants associated with the App.ManagedDomainMappings property. Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

View Source 
const (
	App_RunServiceAccount_Default = "default"
	App_RunServiceAccount_Manager = "manager"
	App_RunServiceAccount_None    = "none"
	App_RunServiceAccount_Reader  = "reader"
	App_RunServiceAccount_Writer  = "writer"
)

Constants associated with the App.RunServiceAccount property. Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.

View Source 
const (
	App_Status_Deploying = "deploying"
	App_Status_Failed    = "failed"
	App_Status_Ready     = "ready"
	App_Status_Warning   = "warning"
)

Constants associated with the App.Status property. The current status of the app.

View Source 
const (
	AppPatch_ManagedDomainMappings_Local        = "local"
	AppPatch_ManagedDomainMappings_LocalPrivate = "local_private"
	AppPatch_ManagedDomainMappings_LocalPublic  = "local_public"
)

Constants associated with the AppPatch.ManagedDomainMappings property. Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

View Source 
const (
	AppPatch_RunServiceAccount_Default = "default"
	AppPatch_RunServiceAccount_Manager = "manager"
	AppPatch_RunServiceAccount_None    = "none"
	AppPatch_RunServiceAccount_Reader  = "reader"
	AppPatch_RunServiceAccount_Writer  = "writer"
)

Constants associated with the AppPatch.RunServiceAccount property. Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.

View Source 
const (
	AppRevision_RunServiceAccount_Default = "default"
	AppRevision_RunServiceAccount_Manager = "manager"
	AppRevision_RunServiceAccount_None    = "none"
	AppRevision_RunServiceAccount_Reader  = "reader"
	AppRevision_RunServiceAccount_Writer  = "writer"
)

Constants associated with the AppRevision.RunServiceAccount property. Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.

View Source 
const (
	AppRevision_Status_Failed  = "failed"
	AppRevision_Status_Loading = "loading"
	AppRevision_Status_Ready   = "ready"
	AppRevision_Status_Warning = "warning"
)

Constants associated with the AppRevision.Status property. The current status of the app revision.

View Source 
const (
	AppRevisionStatus_Reason_ContainerFailedExitCode0               = "container_failed_exit_code_0"
	AppRevisionStatus_Reason_ContainerFailedExitCode1               = "container_failed_exit_code_1"
	AppRevisionStatus_Reason_ContainerFailedExitCode139             = "container_failed_exit_code_139"
	AppRevisionStatus_Reason_ContainerFailedExitCode24              = "container_failed_exit_code_24"
	AppRevisionStatus_Reason_Deploying                              = "deploying"
	AppRevisionStatus_Reason_DeployingWaitingForResources           = "deploying_waiting_for_resources"
	AppRevisionStatus_Reason_FetchImageFailedMissingPullCredentials = "fetch_image_failed_missing_pull_credentials"
	AppRevisionStatus_Reason_FetchImageFailedMissingPullSecret      = "fetch_image_failed_missing_pull_secret"
	AppRevisionStatus_Reason_FetchImageFailedRegistryNotFound       = "fetch_image_failed_registry_not_found"
	AppRevisionStatus_Reason_FetchImageFailedUnknownManifest        = "fetch_image_failed_unknown_manifest"
	AppRevisionStatus_Reason_FetchImageFailedUnknownRepository      = "fetch_image_failed_unknown_repository"
	AppRevisionStatus_Reason_FetchImageFailedWrongPullCredentials   = "fetch_image_failed_wrong_pull_credentials"
	AppRevisionStatus_Reason_ImagePullBackOff                       = "image_pull_back_off"
	AppRevisionStatus_Reason_InitialScaleNeverAchieved              = "initial_scale_never_achieved"
	AppRevisionStatus_Reason_InvalidTarHeaderImagePullErr           = "invalid_tar_header_image_pull_err"
	AppRevisionStatus_Reason_Ready                                  = "ready"
	AppRevisionStatus_Reason_Waiting                                = "waiting"
)

Constants associated with the AppRevisionStatus.Reason property. Optional information to provide more context in case of a 'failed' or 'warning' status.

View Source 
const (
	AppStatus_Reason_Deploying                    = "deploying"
	AppStatus_Reason_NoRevisionReady              = "no_revision_ready"
	AppStatus_Reason_Ready                        = "ready"
	AppStatus_Reason_ReadyButLatestRevisionFailed = "ready_but_latest_revision_failed"
	AppStatus_Reason_WaitingForResources          = "waiting_for_resources"
)

Constants associated with the AppStatus.Reason property. Optional information to provide more context in case of a 'failed' or 'warning' status.

View Source 
const (
	Build_SourceType_Git   = "git"
	Build_SourceType_Local = "local"
)

Constants associated with the Build.SourceType property. Specifies the type of source to determine if your build source is in a repository or based on local source code. * local - For builds from local source code. * git - For builds from git version controlled source code.

View Source 
const (
	Build_Status_Failed = "failed"
	Build_Status_Ready  = "ready"
)

Constants associated with the Build.Status property. The current status of the build.

View Source 
const (
	BuildPatch_SourceType_Git   = "git"
	BuildPatch_SourceType_Local = "local"
)

Constants associated with the BuildPatch.SourceType property. Specifies the type of source to determine if your build source is in a repository or based on local source code. * local - For builds from local source code. * git - For builds from git version controlled source code.

View Source 
const (
	BuildRun_ServiceAccount_Default = "default"
	BuildRun_ServiceAccount_Manager = "manager"
	BuildRun_ServiceAccount_None    = "none"
	BuildRun_ServiceAccount_Reader  = "reader"
	BuildRun_ServiceAccount_Writer  = "writer"
)

Constants associated with the BuildRun.ServiceAccount property. Optional service account which is used for resource control.

View Source 
const (
	BuildRun_SourceType_Git   = "git"
	BuildRun_SourceType_Local = "local"
)

Constants associated with the BuildRun.SourceType property. Specifies the type of source to determine if your build source is in a repository or based on local source code. * local - For builds from local source code. * git - For builds from git version controlled source code.

View Source 
const (
	BuildRun_Status_Failed    = "failed"
	BuildRun_Status_Pending   = "pending"
	BuildRun_Status_Running   = "running"
	BuildRun_Status_Succeeded = "succeeded"
)

Constants associated with the BuildRun.Status property. The current status of the build run.

View Source 
const (
	BuildRunStatus_Reason_BuildNotFound                          = "build_not_found"
	BuildRunStatus_Reason_ExceededEphemeralStorage               = "exceeded_ephemeral_storage"
	BuildRunStatus_Reason_Failed                                 = "failed"
	BuildRunStatus_Reason_FailedToExecuteBuildRun                = "failed_to_execute_build_run"
	BuildRunStatus_Reason_InvalidBuildConfiguration              = "invalid_build_configuration"
	BuildRunStatus_Reason_MissingCodeRepoAccess                  = "missing_code_repo_access"
	BuildRunStatus_Reason_MissingRegistryAccess                  = "missing_registry_access"
	BuildRunStatus_Reason_MissingSecrets                         = "missing_secrets"
	BuildRunStatus_Reason_MissingTaskRun                         = "missing_task_run"
	BuildRunStatus_Reason_Pending                                = "pending"
	BuildRunStatus_Reason_PodEvicted                             = "pod_evicted"
	BuildRunStatus_Reason_PodEvictedBecauseOfStorageQuotaExceeds = "pod_evicted_because_of_storage_quota_exceeds"
	BuildRunStatus_Reason_Running                                = "running"
	BuildRunStatus_Reason_Succeeded                              = "succeeded"
	BuildRunStatus_Reason_TaskRunGenerationFailed                = "task_run_generation_failed"
	BuildRunStatus_Reason_Timeout                                = "timeout"
	BuildRunStatus_Reason_UnknownStrategy                        = "unknown_strategy"
)

Constants associated with the BuildRunStatus.Reason property. Optional information to provide more context in case of a 'failed' or 'warning' status.

View Source 
const (
	BuildStatus_Reason_ClusterBuildStrategyNotFound = "cluster_build_strategy_not_found"
	BuildStatus_Reason_Failed                       = "failed"
	BuildStatus_Reason_MultipleSecretRefNotFound    = "multiple_secret_ref_not_found"
	BuildStatus_Reason_Registered                   = "registered"
	BuildStatus_Reason_RemoteRepositoryUnreachable  = "remote_repository_unreachable"
	BuildStatus_Reason_RuntimePathsCanNotBeEmpty    = "runtime_paths_can_not_be_empty"
	BuildStatus_Reason_SetOwnerReferenceFailed      = "set_owner_reference_failed"
	BuildStatus_Reason_SpecOutputSecretRefNotFound  = "spec_output_secret_ref_not_found"
	BuildStatus_Reason_SpecRuntimeSecretRefNotFound = "spec_runtime_secret_ref_not_found"
	BuildStatus_Reason_SpecSourceSecretNotFound     = "spec_source_secret_not_found"
	BuildStatus_Reason_StrategyNotFound             = "strategy_not_found"
)

Constants associated with the BuildStatus.Reason property. Optional information to provide more context in case of a 'failed' or 'warning' status.

View Source 
const (
	CreateAppOptions_ManagedDomainMappings_Local        = "local"
	CreateAppOptions_ManagedDomainMappings_LocalPrivate = "local_private"
	CreateAppOptions_ManagedDomainMappings_LocalPublic  = "local_public"
)

Constants associated with the CreateAppOptions.ManagedDomainMappings property. Optional value controlling which of the system managed domain mappings will be setup for the application. Valid values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project supports application private visibility.

View Source 
const (
	CreateAppOptions_RunServiceAccount_Default = "default"
	CreateAppOptions_RunServiceAccount_Manager = "manager"
	CreateAppOptions_RunServiceAccount_None    = "none"
	CreateAppOptions_RunServiceAccount_Reader  = "reader"
	CreateAppOptions_RunServiceAccount_Writer  = "writer"
)

Constants associated with the CreateAppOptions.RunServiceAccount property. Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` , `none`, `reader`, and `writer`.

View Source 
const (
	CreateBuildOptions_SourceType_Git   = "git"
	CreateBuildOptions_SourceType_Local = "local"
)

Constants associated with the CreateBuildOptions.SourceType property. Specifies the type of source to determine if your build source is in a repository or based on local source code. * local - For builds from local source code. * git - For builds from git version controlled source code.

View Source 
const (
	CreateBuildRunOptions_ServiceAccount_Default = "default"
	CreateBuildRunOptions_ServiceAccount_Manager = "manager"
	CreateBuildRunOptions_ServiceAccount_None    = "none"
	CreateBuildRunOptions_ServiceAccount_Reader  = "reader"
	CreateBuildRunOptions_ServiceAccount_Writer  = "writer"
)

Constants associated with the CreateBuildRunOptions.ServiceAccount property. Optional service account which is used for resource control.

View Source 
const (
	CreateBuildRunOptions_SourceType_Git   = "git"
	CreateBuildRunOptions_SourceType_Local = "local"
)

Constants associated with the CreateBuildRunOptions.SourceType property. Specifies the type of source to determine if your build source is in a repository or based on local source code. * local - For builds from local source code. * git - For builds from git version controlled source code.

View Source 
const (
	CreateJobOptions_RunMode_Daemon = "daemon"
	CreateJobOptions_RunMode_Task   = "task"
)

Constants associated with the CreateJobOptions.RunMode property. The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.

View Source 
const (
	CreateJobOptions_RunServiceAccount_Default = "default"
	CreateJobOptions_RunServiceAccount_Manager = "manager"
	CreateJobOptions_RunServiceAccount_None    = "none"
	CreateJobOptions_RunServiceAccount_Reader  = "reader"
	CreateJobOptions_RunServiceAccount_Writer  = "writer"
)

Constants associated with the CreateJobOptions.RunServiceAccount property. The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.

View Source 
const (
	CreateJobRunOptions_RunMode_Daemon = "daemon"
	CreateJobRunOptions_RunMode_Task   = "task"
)

Constants associated with the CreateJobRunOptions.RunMode property. The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.

View Source 
const (
	CreateJobRunOptions_RunServiceAccount_Default = "default"
	CreateJobRunOptions_RunServiceAccount_Manager = "manager"
	CreateJobRunOptions_RunServiceAccount_None    = "none"
	CreateJobRunOptions_RunServiceAccount_Reader  = "reader"
	CreateJobRunOptions_RunServiceAccount_Writer  = "writer"
)

Constants associated with the CreateJobRunOptions.RunServiceAccount property. The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.

View Source 
const (
	CreateSecretOptions_Format_BasicAuth       = "basic_auth"
	CreateSecretOptions_Format_Generic         = "generic"
	CreateSecretOptions_Format_Other           = "other"
	CreateSecretOptions_Format_Registry        = "registry"
	CreateSecretOptions_Format_ServiceAccess   = "service_access"
	CreateSecretOptions_Format_ServiceOperator = "service_operator"
	CreateSecretOptions_Format_SshAuth         = "ssh_auth"
	CreateSecretOptions_Format_Tls             = "tls"
)

Constants associated with the CreateSecretOptions.Format property. Specify the format of the secret. The format of the secret will determine how the secret is used.

View Source 
const (
	DomainMapping_Status_Deploying = "deploying"
	DomainMapping_Status_Failed    = "failed"
	DomainMapping_Status_Ready     = "ready"
)

Constants associated with the DomainMapping.Status property. The current status of the domain mapping.

View Source 
const (
	DomainMapping_Visibility_Custom  = "custom"
	DomainMapping_Visibility_Private = "private"
	DomainMapping_Visibility_Project = "project"
	DomainMapping_Visibility_Public  = "public"
)

Constants associated with the DomainMapping.Visibility property. Exposes whether the domain mapping is reachable through the public internet, or private IBM network, or only through other components within the same Code Engine project.

View Source 
const (
	DomainMappingStatus_Reason_AppRefFailed           = "app_ref_failed"
	DomainMappingStatus_Reason_Deploying              = "deploying"
	DomainMappingStatus_Reason_DomainAlreadyClaimed   = "domain_already_claimed"
	DomainMappingStatus_Reason_Failed                 = "failed"
	DomainMappingStatus_Reason_FailedReconcileIngress = "failed_reconcile_ingress"
	DomainMappingStatus_Reason_Ready                  = "ready"
)

Constants associated with the DomainMappingStatus.Reason property. Optional information to provide more context in case of a 'failed' or 'warning' status.

View Source 
const (
	EnvVar_Type_ConfigMapFullReference = "config_map_full_reference"
	EnvVar_Type_ConfigMapKeyReference  = "config_map_key_reference"
	EnvVar_Type_Literal                = "literal"
	EnvVar_Type_SecretFullReference    = "secret_full_reference"
	EnvVar_Type_SecretKeyReference     = "secret_key_reference"
)

Constants associated with the EnvVar.Type property. Specify the type of the environment variable.

View Source 
const (
	EnvVarPrototype_Type_ConfigMapFullReference = "config_map_full_reference"
	EnvVarPrototype_Type_ConfigMapKeyReference  = "config_map_key_reference"
	EnvVarPrototype_Type_Literal                = "literal"
	EnvVarPrototype_Type_SecretFullReference    = "secret_full_reference"
	EnvVarPrototype_Type_SecretKeyReference     = "secret_key_reference"
)

Constants associated with the EnvVarPrototype.Type property. Specify the type of the environment variable.

View Source 
const (
	Job_RunMode_Daemon = "daemon"
	Job_RunMode_Task   = "task"
)

Constants associated with the Job.RunMode property. The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.

View Source 
const (
	Job_RunServiceAccount_Default = "default"
	Job_RunServiceAccount_Manager = "manager"
	Job_RunServiceAccount_None    = "none"
	Job_RunServiceAccount_Reader  = "reader"
	Job_RunServiceAccount_Writer  = "writer"
)

Constants associated with the Job.RunServiceAccount property. The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.

View Source 
const (
	JobPatch_RunMode_Daemon = "daemon"
	JobPatch_RunMode_Task   = "task"
)

Constants associated with the JobPatch.RunMode property. The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.

View Source 
const (
	JobPatch_RunServiceAccount_Default = "default"
	JobPatch_RunServiceAccount_Manager = "manager"
	JobPatch_RunServiceAccount_None    = "none"
	JobPatch_RunServiceAccount_Reader  = "reader"
	JobPatch_RunServiceAccount_Writer  = "writer"
)

Constants associated with the JobPatch.RunServiceAccount property. The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.

View Source 
const (
	JobRun_RunMode_Daemon = "daemon"
	JobRun_RunMode_Task   = "task"
)

Constants associated with the JobRun.RunMode property. The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.

View Source 
const (
	JobRun_RunServiceAccount_Default = "default"
	JobRun_RunServiceAccount_Manager = "manager"
	JobRun_RunServiceAccount_None    = "none"
	JobRun_RunServiceAccount_Reader  = "reader"
	JobRun_RunServiceAccount_Writer  = "writer"
)

Constants associated with the JobRun.RunServiceAccount property. The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`, `reader`, and `writer`. This property must not be set on a job run, which references a job template.

View Source 
const (
	JobRun_Status_Completed = "completed"
	JobRun_Status_Failed    = "failed"
	JobRun_Status_Pending   = "pending"
	JobRun_Status_Running   = "running"
)

Constants associated with the JobRun.Status property. The current status of the job run.

View Source 
const (
	Probe_Type_Http = "http"
	Probe_Type_Tcp  = "tcp"
)

Constants associated with the Probe.Type property. Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

View Source 
const (
	ProbePrototype_Type_Http = "http"
	ProbePrototype_Type_Tcp  = "tcp"
)

Constants associated with the ProbePrototype.Type property. Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.

View Source 
const (
	Project_Status_Active             = "active"
	Project_Status_Creating           = "creating"
	Project_Status_CreationFailed     = "creation_failed"
	Project_Status_Deleting           = "deleting"
	Project_Status_DeletionFailed     = "deletion_failed"
	Project_Status_HardDeleted        = "hard_deleted"
	Project_Status_HardDeleting       = "hard_deleting"
	Project_Status_HardDeletionFailed = "hard_deletion_failed"
	Project_Status_Inactive           = "inactive"
	Project_Status_PendingRemoval     = "pending_removal"
	Project_Status_Preparing          = "preparing"
	Project_Status_SoftDeleted        = "soft_deleted"
)

Constants associated with the Project.Status property. The current state of the project. For example, if the project is created and ready to get used, it will return active.

View Source 
const (
	ProjectStatusDetails_Domain_Ready   = "ready"
	ProjectStatusDetails_Domain_Unknown = "unknown"
)

Constants associated with the ProjectStatusDetails.Domain property. Status of the domain created for the project.

View Source 
const (
	ProjectStatusDetails_Project_Disabled = "disabled"
	ProjectStatusDetails_Project_Enabled  = "enabled"
)

Constants associated with the ProjectStatusDetails.Project property. Defines whether a project is enabled for management and consumption.

View Source 
const (
	ReplaceSecretOptions_Format_BasicAuth       = "basic_auth"
	ReplaceSecretOptions_Format_Generic         = "generic"
	ReplaceSecretOptions_Format_Other           = "other"
	ReplaceSecretOptions_Format_Registry        = "registry"
	ReplaceSecretOptions_Format_ServiceAccess   = "service_access"
	ReplaceSecretOptions_Format_ServiceOperator = "service_operator"
	ReplaceSecretOptions_Format_SshAuth         = "ssh_auth"
	ReplaceSecretOptions_Format_Tls             = "tls"
)

Constants associated with the ReplaceSecretOptions.Format property. Specify the format of the secret. The format of the secret will determine how the secret is used.

View Source 
const (
	Secret_Format_BasicAuth       = "basic_auth"
	Secret_Format_Generic         = "generic"
	Secret_Format_Other           = "other"
	Secret_Format_Registry        = "registry"
	Secret_Format_ServiceAccess   = "service_access"
	Secret_Format_ServiceOperator = "service_operator"
	Secret_Format_SshAuth         = "ssh_auth"
	Secret_Format_Tls             = "tls"
)

Constants associated with the Secret.Format property. Specify the format of the secret.

View Source 
const (
	VolumeMount_Type_ConfigMap = "config_map"
	VolumeMount_Type_Secret    = "secret"
)

Constants associated with the VolumeMount.Type property. Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

View Source 
const (
	VolumeMountPrototype_Type_ConfigMap = "config_map"
	VolumeMountPrototype_Type_Secret    = "secret"
)

Constants associated with the VolumeMountPrototype.Type property. Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.

View Source 
const (
	AppRevision_ResourceType_AppRevisionV2 = "app_revision_v2"
)

Constants associated with the AppRevision.ResourceType property. The type of the app revision.

View Source 
const (
	App_ResourceType_AppV2 = "app_v2"
)

Constants associated with the App.ResourceType property. The type of the app.

View Source 
const (
	Binding_ResourceType_BindingV2 = "binding_v2"
)

Constants associated with the Binding.ResourceType property. The type of the binding.

View Source 
const (
	BuildRun_ResourceType_BuildRunV2 = "build_run_v2"
)

Constants associated with the BuildRun.ResourceType property. The type of the build run.

View Source 
const (
	Build_ResourceType_BuildV2 = "build_v2"
)

Constants associated with the Build.ResourceType property. The type of the build.

View Source 
const (
	ConfigMap_ResourceType_ConfigMapV2 = "config_map_v2"
)

Constants associated with the ConfigMap.ResourceType property. The type of the config map.

View Source 
const DefaultServiceName = "code_engine"

DefaultServiceName is the default key used to find external configuration information.

View Source 
const DefaultServiceURL = "https://api.au-syd.codeengine.cloud.ibm.com/v2"

DefaultServiceURL is the default URL to make service requests to.

View Source 
const (
	DomainMapping_ResourceType_DomainMappingV2 = "domain_mapping_v2"
)

Constants associated with the DomainMapping.ResourceType property. The type of the CE Resource.

View Source 
const (
	JobRun_ResourceType_JobRunV2 = "job_run_v2"
)

Constants associated with the JobRun.ResourceType property. The type of the job run.

View Source 
const (
	Job_ResourceType_JobV2 = "job_v2"
)

Constants associated with the Job.ResourceType property. The type of the job.

View Source 
const (
	Project_ResourceType_ProjectV2 = "project_v2"
)

Constants associated with the Project.ResourceType property. The type of the project.

Variables

This section is empty.

Functions

func GetServiceURLForRegion 

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalApp 

func UnmarshalApp(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalApp unmarshals an instance of App from the specified map of raw messages.

func UnmarshalAppList 

func UnmarshalAppList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppList unmarshals an instance of AppList from the specified map of raw messages.

func UnmarshalAppPatch 

func UnmarshalAppPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppPatch unmarshals an instance of AppPatch from the specified map of raw messages.

func UnmarshalAppRevision 

func UnmarshalAppRevision(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppRevision unmarshals an instance of AppRevision from the specified map of raw messages.

func UnmarshalAppRevisionList 

func UnmarshalAppRevisionList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppRevisionList unmarshals an instance of AppRevisionList from the specified map of raw messages.

func UnmarshalAppRevisionStatus 

func UnmarshalAppRevisionStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppRevisionStatus unmarshals an instance of AppRevisionStatus from the specified map of raw messages.

func UnmarshalAppStatus 

func UnmarshalAppStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalAppStatus unmarshals an instance of AppStatus from the specified map of raw messages.

func UnmarshalBinding 

func UnmarshalBinding(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBinding unmarshals an instance of Binding from the specified map of raw messages.

func UnmarshalBindingList 

func UnmarshalBindingList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBindingList unmarshals an instance of BindingList from the specified map of raw messages.

func UnmarshalBuild 

func UnmarshalBuild(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuild unmarshals an instance of Build from the specified map of raw messages.

func UnmarshalBuildList 

func UnmarshalBuildList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildList unmarshals an instance of BuildList from the specified map of raw messages.

func UnmarshalBuildPatch 

func UnmarshalBuildPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildPatch unmarshals an instance of BuildPatch from the specified map of raw messages.

func UnmarshalBuildRun 

func UnmarshalBuildRun(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildRun unmarshals an instance of BuildRun from the specified map of raw messages.

func UnmarshalBuildRunList 

func UnmarshalBuildRunList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildRunList unmarshals an instance of BuildRunList from the specified map of raw messages.

func UnmarshalBuildRunStatus 

func UnmarshalBuildRunStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildRunStatus unmarshals an instance of BuildRunStatus from the specified map of raw messages.

func UnmarshalBuildStatus 

func UnmarshalBuildStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBuildStatus unmarshals an instance of BuildStatus from the specified map of raw messages.

func UnmarshalComponentRef 

func UnmarshalComponentRef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalComponentRef unmarshals an instance of ComponentRef from the specified map of raw messages.

func UnmarshalConfigMap 

func UnmarshalConfigMap(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigMap unmarshals an instance of ConfigMap from the specified map of raw messages.

func UnmarshalConfigMapList 

func UnmarshalConfigMapList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalConfigMapList unmarshals an instance of ConfigMapList from the specified map of raw messages.

func UnmarshalDomainMapping 

func UnmarshalDomainMapping(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDomainMapping unmarshals an instance of DomainMapping from the specified map of raw messages.

func UnmarshalDomainMappingList 

func UnmarshalDomainMappingList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDomainMappingList unmarshals an instance of DomainMappingList from the specified map of raw messages.

func UnmarshalDomainMappingPatch 

func UnmarshalDomainMappingPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDomainMappingPatch unmarshals an instance of DomainMappingPatch from the specified map of raw messages.

func UnmarshalDomainMappingStatus 

func UnmarshalDomainMappingStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalDomainMappingStatus unmarshals an instance of DomainMappingStatus from the specified map of raw messages.

func UnmarshalEnvVar 

func UnmarshalEnvVar(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEnvVar unmarshals an instance of EnvVar from the specified map of raw messages.

func UnmarshalEnvVarPrototype 

func UnmarshalEnvVarPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEnvVarPrototype unmarshals an instance of EnvVarPrototype from the specified map of raw messages.

func UnmarshalJob 

func UnmarshalJob(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJob unmarshals an instance of Job from the specified map of raw messages.

func UnmarshalJobList 

func UnmarshalJobList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJobList unmarshals an instance of JobList from the specified map of raw messages.

func UnmarshalJobPatch 

func UnmarshalJobPatch(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJobPatch unmarshals an instance of JobPatch from the specified map of raw messages.

func UnmarshalJobRun 

func UnmarshalJobRun(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJobRun unmarshals an instance of JobRun from the specified map of raw messages.

func UnmarshalJobRunList 

func UnmarshalJobRunList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJobRunList unmarshals an instance of JobRunList from the specified map of raw messages.

func UnmarshalJobRunStatus 

func UnmarshalJobRunStatus(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalJobRunStatus unmarshals an instance of JobRunStatus from the specified map of raw messages.

func UnmarshalListFirstMetadata 

func UnmarshalListFirstMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListFirstMetadata unmarshals an instance of ListFirstMetadata from the specified map of raw messages.

func UnmarshalListNextMetadata 

func UnmarshalListNextMetadata(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalListNextMetadata unmarshals an instance of ListNextMetadata from the specified map of raw messages.

func UnmarshalOperatorSecretProps 

func UnmarshalOperatorSecretProps(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOperatorSecretProps unmarshals an instance of OperatorSecretProps from the specified map of raw messages.

func UnmarshalOperatorSecretPrototypeProps 

func UnmarshalOperatorSecretPrototypeProps(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalOperatorSecretPrototypeProps unmarshals an instance of OperatorSecretPrototypeProps from the specified map of raw messages.

func UnmarshalProbe 

func UnmarshalProbe(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProbe unmarshals an instance of Probe from the specified map of raw messages.

func UnmarshalProbePrototype 

func UnmarshalProbePrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProbePrototype unmarshals an instance of ProbePrototype from the specified map of raw messages.

func UnmarshalProject 

func UnmarshalProject(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProject unmarshals an instance of Project from the specified map of raw messages.

func UnmarshalProjectEgressIPAddresses 

func UnmarshalProjectEgressIPAddresses(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectEgressIPAddresses unmarshals an instance of ProjectEgressIPAddresses from the specified map of raw messages.

func UnmarshalProjectList 

func UnmarshalProjectList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectList unmarshals an instance of ProjectList from the specified map of raw messages.

func UnmarshalProjectStatusDetails 

func UnmarshalProjectStatusDetails(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalProjectStatusDetails unmarshals an instance of ProjectStatusDetails from the specified map of raw messages.

func UnmarshalResourceKeyRef 

func UnmarshalResourceKeyRef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceKeyRef unmarshals an instance of ResourceKeyRef from the specified map of raw messages.

func UnmarshalResourceKeyRefPrototype 

func UnmarshalResourceKeyRefPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalResourceKeyRefPrototype unmarshals an instance of ResourceKeyRefPrototype from the specified map of raw messages.

func UnmarshalRoleRef 

func UnmarshalRoleRef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRoleRef unmarshals an instance of RoleRef from the specified map of raw messages.

func UnmarshalRoleRefPrototype 

func UnmarshalRoleRefPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRoleRefPrototype unmarshals an instance of RoleRefPrototype from the specified map of raw messages.

func UnmarshalSecret 

func UnmarshalSecret(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecret unmarshals an instance of Secret from the specified map of raw messages.

func UnmarshalSecretData 

func UnmarshalSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretData unmarshals an instance of SecretData from the specified map of raw messages.

func UnmarshalSecretDataBasicAuthSecretData 

func UnmarshalSecretDataBasicAuthSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretDataBasicAuthSecretData unmarshals an instance of SecretDataBasicAuthSecretData from the specified map of raw messages.

func UnmarshalSecretDataGenericSecretData 

func UnmarshalSecretDataGenericSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretDataGenericSecretData unmarshals an instance of SecretDataGenericSecretData from the specified map of raw messages.

func UnmarshalSecretDataRegistrySecretData 

func UnmarshalSecretDataRegistrySecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretDataRegistrySecretData unmarshals an instance of SecretDataRegistrySecretData from the specified map of raw messages.

func UnmarshalSecretDataSSHSecretData 

func UnmarshalSecretDataSSHSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretDataSSHSecretData unmarshals an instance of SecretDataSSHSecretData from the specified map of raw messages.

func UnmarshalSecretDataTLSSecretData 

func UnmarshalSecretDataTLSSecretData(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretDataTLSSecretData unmarshals an instance of SecretDataTLSSecretData from the specified map of raw messages.

func UnmarshalSecretList 

func UnmarshalSecretList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSecretList unmarshals an instance of SecretList from the specified map of raw messages.

func UnmarshalServiceAccessSecretProps 

func UnmarshalServiceAccessSecretProps(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceAccessSecretProps unmarshals an instance of ServiceAccessSecretProps from the specified map of raw messages.

func UnmarshalServiceAccessSecretPrototypeProps 

func UnmarshalServiceAccessSecretPrototypeProps(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceAccessSecretPrototypeProps unmarshals an instance of ServiceAccessSecretPrototypeProps from the specified map of raw messages.

func UnmarshalServiceIDRef 

func UnmarshalServiceIDRef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceIDRef unmarshals an instance of ServiceIDRef from the specified map of raw messages.

func UnmarshalServiceIDRefPrototype 

func UnmarshalServiceIDRefPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceIDRefPrototype unmarshals an instance of ServiceIDRefPrototype from the specified map of raw messages.

func UnmarshalServiceInstanceRef 

func UnmarshalServiceInstanceRef(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceInstanceRef unmarshals an instance of ServiceInstanceRef from the specified map of raw messages.

func UnmarshalServiceInstanceRefPrototype 

func UnmarshalServiceInstanceRefPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalServiceInstanceRefPrototype unmarshals an instance of ServiceInstanceRefPrototype from the specified map of raw messages.

func UnmarshalVolumeMount 

func UnmarshalVolumeMount(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalVolumeMount unmarshals an instance of VolumeMount from the specified map of raw messages.

func UnmarshalVolumeMountPrototype 

func UnmarshalVolumeMountPrototype(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalVolumeMountPrototype unmarshals an instance of VolumeMountPrototype from the specified map of raw messages.

Types

type App 

type App struct {
	// Reference to a build that is associated with the application.
	Build *string `json:"build,omitempty"`

	// Reference to a buildrun that is associated with the application.
	BuildRun *string `json:"build_run,omitempty"`

	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// Optional URL to invoke app. Depending on visibility this is accessible publicly or in the private network only.
	// Empty in case 'managed_domain_mappings' is set to 'local'.
	Endpoint *string `json:"endpoint,omitempty"`

	// URL to app that is only visible within the project.
	EndpointInternal *string `json:"endpoint_internal,omitempty"`

	// The version of the app instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// When you provision a new app,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is
	// used to connect to the port that is exposed by the container image.
	ImagePort *int64 `json:"image_port,omitempty"`

	// The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference" validate:"required"`

	// Optional name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Optional value controlling which of the system managed domain mappings will be setup for the application. Valid
	// values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project
	// supports application private visibility.
	ManagedDomainMappings *string `json:"managed_domain_mappings" validate:"required"`

	// The name of the app.
	Name *string `json:"name" validate:"required"`

	// Response model for probes.
	ProbeLiveness *Probe `json:"probe_liveness,omitempty"`

	// Response model for probes.
	ProbeReadiness *Probe `json:"probe_readiness,omitempty"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the app.
	ResourceType *string `json:"resource_type,omitempty"`

	// Optional arguments for the app that are passed to start the container. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments" validate:"required"`

	// Optional user ID (UID) to run the app (e.g., `1001`).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Optional commands for the app that are passed to start the container. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands" validate:"required"`

	// References to config maps, secrets or literal values, which are exposed as environment variables in the application.
	RunEnvVariables []EnvVar `json:"run_env_variables" validate:"required"`

	// Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` ,
	// `none`, `reader`, and `writer`.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Mounts of config maps or secrets.
	RunVolumeMounts []VolumeMount `json:"run_volume_mounts" validate:"required"`

	// Optional maximum number of requests that can be processed concurrently per instance.
	ScaleConcurrency *int64 `json:"scale_concurrency,omitempty"`

	// Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use
	// this value to scale up instances based on concurrent number of requests. This option defaults to the value of the
	// `scale_concurrency` option, if not specified.
	ScaleConcurrencyTarget *int64 `json:"scale_concurrency_target,omitempty"`

	// Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit" validate:"required"`

	// Optional amount of time in seconds that delays the scale down behavior for an app instance.
	ScaleDownDelay *int64 `json:"scale_down_delay,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit" validate:"required"`

	// Optional initial number of instances that are created upon app creation or app update.
	ScaleInitialInstances *int64 `json:"scale_initial_instances,omitempty"`

	// Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper
	// scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas
	// for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).
	ScaleMaxInstances *int64 `json:"scale_max_instances" validate:"required"`

	// Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit" validate:"required"`

	// Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if
	// not hit by any request for some time.
	ScaleMinInstances *int64 `json:"scale_min_instances" validate:"required"`

	// Optional amount of time in seconds that is allowed for a running app to respond to a request.
	ScaleRequestTimeout *int64 `json:"scale_request_timeout" validate:"required"`

	// The current status of the app.
	Status *string `json:"status,omitempty"`

	// The detailed status of the application.
	StatusDetails *AppStatus `json:"status_details,omitempty"`
}

App : App is the response model for app resources.

type AppList 

type AppList struct {
	// List of all apps.
	Apps []App `json:"apps" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

AppList : Contains a list of apps and pagination information.

func (*AppList) GetNextStart 

func (resp *AppList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type AppPatch 

type AppPatch struct {
	// Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is
	// used to connect to the port that is exposed by the container image.
	ImagePort *int64 `json:"image_port,omitempty"`

	// The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference,omitempty"`

	// Optional name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Optional value controlling which of the system managed domain mappings will be setup for the application. Valid
	// values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project
	// supports application private visibility.
	ManagedDomainMappings *string `json:"managed_domain_mappings,omitempty"`

	// Request model for probes.
	ProbeLiveness *ProbePrototype `json:"probe_liveness,omitempty"`

	// Request model for probes.
	ProbeReadiness *ProbePrototype `json:"probe_readiness,omitempty"`

	// Optional arguments for the app that are passed to start the container. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments,omitempty"`

	// Optional user ID (UID) to run the app (e.g., `1001`).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Optional commands for the app that are passed to start the container. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands,omitempty"`

	// Optional references to config maps, secrets or literal values.
	RunEnvVariables []EnvVarPrototype `json:"run_env_variables,omitempty"`

	// Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` ,
	// `none`, `reader`, and `writer`.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets. In case this is provided, existing `run_volume_mounts` will be
	// overwritten.
	RunVolumeMounts []VolumeMountPrototype `json:"run_volume_mounts,omitempty"`

	// Optional maximum number of requests that can be processed concurrently per instance.
	ScaleConcurrency *int64 `json:"scale_concurrency,omitempty"`

	// Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use
	// this value to scale up instances based on concurrent number of requests. This option defaults to the value of the
	// `scale_concurrency` option, if not specified.
	ScaleConcurrencyTarget *int64 `json:"scale_concurrency_target,omitempty"`

	// Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of time in seconds that delays the scale down behavior for an app instance.
	ScaleDownDelay *int64 `json:"scale_down_delay,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// Optional initial number of instances that are created upon app creation or app update.
	ScaleInitialInstances *int64 `json:"scale_initial_instances,omitempty"`

	// Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper
	// scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas
	// for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).
	ScaleMaxInstances *int64 `json:"scale_max_instances,omitempty"`

	// Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if
	// not hit by any request for some time.
	ScaleMinInstances *int64 `json:"scale_min_instances,omitempty"`

	// Optional amount of time in seconds that is allowed for a running app to respond to a request.
	ScaleRequestTimeout *int64 `json:"scale_request_timeout,omitempty"`
}

AppPatch : App is the request model for app update operations.

func (*AppPatch) AsPatch 

func (appPatch *AppPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the AppPatch

type AppRevision 

type AppRevision struct {
	// Name of the associated app.
	AppName *string `json:"app_name,omitempty"`

	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// When you provision a new revision,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is
	// used to connect to the port that is exposed by the container image.
	ImagePort *int64 `json:"image_port,omitempty"`

	// The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference" validate:"required"`

	// Optional name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
	ImageSecret *string `json:"image_secret,omitempty"`

	// The name of the app revison.
	Name *string `json:"name,omitempty"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the app revision.
	ResourceType *string `json:"resource_type,omitempty"`

	// Optional arguments for the app that are passed to start the container. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments" validate:"required"`

	// Optional user ID (UID) to run the app (e.g., `1001`).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Optional commands for the app that are passed to start the container. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands" validate:"required"`

	// References to config maps, secrets or literal values, which are exposed as environment variables in the application.
	RunEnvVariables []EnvVar `json:"run_env_variables" validate:"required"`

	// Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` ,
	// `none`, `reader`, and `writer`.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Mounts of config maps or secrets.
	RunVolumeMounts []VolumeMount `json:"run_volume_mounts" validate:"required"`

	// Optional maximum number of requests that can be processed concurrently per instance.
	ScaleConcurrency *int64 `json:"scale_concurrency,omitempty"`

	// Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use
	// this value to scale up instances based on concurrent number of requests. This option defaults to the value of the
	// `scale_concurrency` option, if not specified.
	ScaleConcurrencyTarget *int64 `json:"scale_concurrency_target,omitempty"`

	// Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit" validate:"required"`

	// Optional amount of time in seconds that delays the scale down behavior for an app instance.
	ScaleDownDelay *int64 `json:"scale_down_delay,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit" validate:"required"`

	// Optional initial number of instances that are created upon app creation or app update.
	ScaleInitialInstances *int64 `json:"scale_initial_instances,omitempty"`

	// Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper
	// scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas
	// for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).
	ScaleMaxInstances *int64 `json:"scale_max_instances" validate:"required"`

	// Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit" validate:"required"`

	// Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if
	// not hit by any request for some time.
	ScaleMinInstances *int64 `json:"scale_min_instances" validate:"required"`

	// Optional amount of time in seconds that is allowed for a running app to respond to a request.
	ScaleRequestTimeout *int64 `json:"scale_request_timeout" validate:"required"`

	// The current status of the app revision.
	Status *string `json:"status,omitempty"`

	// The detailed status of the application revision.
	StatusDetails *AppRevisionStatus `json:"status_details,omitempty"`
}

AppRevision : AppRevision is the response model for app revision resources.

type AppRevisionList 

type AppRevisionList struct {
	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`

	// List of all app revisions.
	Revisions []AppRevision `json:"revisions" validate:"required"`
}

AppRevisionList : Contains a list of app revisions and pagination information.

func (*AppRevisionList) GetNextStart 

func (resp *AppRevisionList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type AppRevisionStatus 

type AppRevisionStatus struct {
	// The number of running instances of the revision.
	ActualInstances *int64 `json:"actual_instances,omitempty"`

	// Optional information to provide more context in case of a 'failed' or 'warning' status.
	Reason *string `json:"reason,omitempty"`
}

AppRevisionStatus : The detailed status of the application revision.

type AppRevisionsPager 

type AppRevisionsPager struct {
	// contains filtered or unexported fields
}

AppRevisionsPager can be used to simplify the use of the "ListAppRevisions" method.

func (*AppRevisionsPager) GetAll 

func (pager *AppRevisionsPager) GetAll() (allItems []AppRevision, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AppRevisionsPager) GetAllWithContext 

func (pager *AppRevisionsPager) GetAllWithContext(ctx context.Context) (allItems []AppRevision, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AppRevisionsPager) GetNext 

func (pager *AppRevisionsPager) GetNext() (page []AppRevision, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AppRevisionsPager) GetNextWithContext 

func (pager *AppRevisionsPager) GetNextWithContext(ctx context.Context) (page []AppRevision, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AppRevisionsPager) HasNext 

func (pager *AppRevisionsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type AppStatus 

type AppStatus struct {
	// Latest app revision that has been created.
	LatestCreatedRevision *string `json:"latest_created_revision,omitempty"`

	// Latest app revision that reached a ready state.
	LatestReadyRevision *string `json:"latest_ready_revision,omitempty"`

	// Optional information to provide more context in case of a 'failed' or 'warning' status.
	Reason *string `json:"reason,omitempty"`
}

AppStatus : The detailed status of the application.

type AppsPager 

type AppsPager struct {
	// contains filtered or unexported fields
}

AppsPager can be used to simplify the use of the "ListApps" method.

func (*AppsPager) GetAll 

func (pager *AppsPager) GetAll() (allItems []App, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*AppsPager) GetAllWithContext 

func (pager *AppsPager) GetAllWithContext(ctx context.Context) (allItems []App, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*AppsPager) GetNext 

func (pager *AppsPager) GetNext() (page []App, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*AppsPager) GetNextWithContext 

func (pager *AppsPager) GetNextWithContext(ctx context.Context) (page []App, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*AppsPager) HasNext 

func (pager *AppsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type Binding 

type Binding struct {
	// A reference to another component.
	Component *ComponentRef `json:"component" validate:"required"`

	// When you provision a new binding,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The ID of the binding.
	ID *string `json:"id,omitempty"`

	// The value that is set as prefix in the component that is bound.
	Prefix *string `json:"prefix" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The type of the binding.
	ResourceType *string `json:"resource_type,omitempty"`

	// The service access secret that is bound to a component.
	SecretName *string `json:"secret_name" validate:"required"`

	// The current status of the binding.
	Status *string `json:"status,omitempty"`
}

Binding : Describes the model of a binding.

type BindingList 

type BindingList struct {
	// List of all bindings.
	Bindings []Binding `json:"bindings" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

BindingList : Contains a list of bindings and pagination information.

func (*BindingList) GetNextStart 

func (resp *BindingList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type BindingsPager 

type BindingsPager struct {
	// contains filtered or unexported fields
}

BindingsPager can be used to simplify the use of the "ListBindings" method.

func (*BindingsPager) GetAll 

func (pager *BindingsPager) GetAll() (allItems []Binding, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*BindingsPager) GetAllWithContext 

func (pager *BindingsPager) GetAllWithContext(ctx context.Context) (allItems []Binding, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*BindingsPager) GetNext 

func (pager *BindingsPager) GetNext() (page []Binding, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*BindingsPager) GetNextWithContext 

func (pager *BindingsPager) GetNextWithContext(ctx context.Context) (page []Binding, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*BindingsPager) HasNext 

func (pager *BindingsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type Build 

type Build struct {
	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// The version of the build instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// When you provision a new build,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the build.
	Name *string `json:"name,omitempty"`

	// The name of the image.
	OutputImage *string `json:"output_image" validate:"required"`

	// The secret that is required to access the image registry. Make sure that the secret is granted with push permissions
	// towards the specified container registry namespace.
	OutputSecret *string `json:"output_secret" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the build.
	ResourceType *string `json:"resource_type,omitempty"`

	// Option directory in the repository that contains the buildpacks file or the Dockerfile.
	SourceContextDir *string `json:"source_context_dir,omitempty"`

	// Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and
	// uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.
	SourceRevision *string `json:"source_revision,omitempty"`

	// Name of the secret that is used access the repository source. This field is optional if the `source_type` is `git`.
	// Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but
	// cannot access any source code, until this property is provided, too. If the `source_type` value is `local`, this
	// field must be omitted.
	SourceSecret *string `json:"source_secret,omitempty"`

	// Specifies the type of source to determine if your build source is in a repository or based on local source code.
	// * local - For builds from local source code.
	// * git - For builds from git version controlled source code.
	SourceType *string `json:"source_type" validate:"required"`

	// The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is
	// `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like
	// `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like
	// `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.
	SourceURL *string `json:"source_url,omitempty"`

	// The current status of the build.
	Status *string `json:"status,omitempty"`

	// The detailed status of the build.
	StatusDetails *BuildStatus `json:"status_details,omitempty"`

	// Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`,
	// `large`, `xlarge`, `xxlarge`.
	StrategySize *string `json:"strategy_size" validate:"required"`

	// Optional path to the specification file that is used for build strategies for building an image.
	StrategySpecFile *string `json:"strategy_spec_file,omitempty"`

	// The strategy to use for building the image.
	StrategyType *string `json:"strategy_type" validate:"required"`

	// The maximum amount of time, in seconds, that can pass before the build must succeed or fail.
	Timeout *int64 `json:"timeout,omitempty"`
}

Build : Response model for build definitions.

type BuildList 

type BuildList struct {
	// List of all builds.
	Builds []Build `json:"builds" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

BuildList : Contains a list of builds and pagination information.

func (*BuildList) GetNextStart 

func (resp *BuildList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type BuildPatch 

type BuildPatch struct {
	// The name of the image.
	OutputImage *string `json:"output_image,omitempty"`

	// The secret that is required to access the image registry. Make sure that the secret is granted with push permissions
	// towards the specified container registry namespace.
	OutputSecret *string `json:"output_secret,omitempty"`

	// Option directory in the repository that contains the buildpacks file or the Dockerfile.
	SourceContextDir *string `json:"source_context_dir,omitempty"`

	// Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and
	// uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.
	SourceRevision *string `json:"source_revision,omitempty"`

	// Name of the secret that is used access the repository source. This field is optional if the `source_type` is `git`.
	// Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but
	// cannot access any source code, until this property is provided, too. If the `source_type` value is `local`, this
	// field must be omitted.
	SourceSecret *string `json:"source_secret,omitempty"`

	// Specifies the type of source to determine if your build source is in a repository or based on local source code.
	// * local - For builds from local source code.
	// * git - For builds from git version controlled source code.
	SourceType *string `json:"source_type,omitempty"`

	// The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is
	// `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like
	// `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like
	// `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.
	SourceURL *string `json:"source_url,omitempty"`

	// Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`,
	// `large`, `xlarge`, `xxlarge`.
	StrategySize *string `json:"strategy_size,omitempty"`

	// Optional path to the specification file that is used for build strategies for building an image.
	StrategySpecFile *string `json:"strategy_spec_file,omitempty"`

	// The strategy to use for building the image.
	StrategyType *string `json:"strategy_type,omitempty"`

	// The maximum amount of time, in seconds, that can pass before the build must succeed or fail.
	Timeout *int64 `json:"timeout,omitempty"`
}

BuildPatch : Patch a build object.

func (*BuildPatch) AsPatch 

func (buildPatch *BuildPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the BuildPatch

type BuildRun 

type BuildRun struct {
	// Optional name of the build on which this build run is based on. If specified, the build run will inherit the
	// configuration of the referenced build. If not specified, make sure to specify at least the fields `strategy_type`,
	// `source_url`, `output_image` and `output_secret` to describe the build run.
	BuildName *string `json:"build_name" validate:"required"`

	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// When you trigger a new build run,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the build run.
	Name *string `json:"name" validate:"required"`

	// The name of the image.
	OutputImage *string `json:"output_image,omitempty"`

	// The secret that is required to access the image registry. Make sure that the secret is granted with push permissions
	// towards the specified container registry namespace.
	OutputSecret *string `json:"output_secret,omitempty"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the build run.
	ResourceType *string `json:"resource_type,omitempty"`

	// Optional service account which is used for resource control.
	ServiceAccount *string `json:"service_account,omitempty"`

	// Option directory in the repository that contains the buildpacks file or the Dockerfile.
	SourceContextDir *string `json:"source_context_dir,omitempty"`

	// Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and
	// uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.
	SourceRevision *string `json:"source_revision,omitempty"`

	// Name of the secret that is used access the repository source. This field is optional if the `source_type` is `git`.
	// Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but
	// cannot access any source code, until this property is provided, too. If the `source_type` value is `local`, this
	// field must be omitted.
	SourceSecret *string `json:"source_secret,omitempty"`

	// Specifies the type of source to determine if your build source is in a repository or based on local source code.
	// * local - For builds from local source code.
	// * git - For builds from git version controlled source code.
	SourceType *string `json:"source_type,omitempty"`

	// The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is
	// `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like
	// `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like
	// `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.
	SourceURL *string `json:"source_url,omitempty"`

	// The current status of the build run.
	Status *string `json:"status,omitempty"`

	// Current status condition of a build run.
	StatusDetails *BuildRunStatus `json:"status_details,omitempty"`

	// Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`,
	// `large`, `xlarge`, `xxlarge`.
	StrategySize *string `json:"strategy_size,omitempty"`

	// Optional path to the specification file that is used for build strategies for building an image.
	StrategySpecFile *string `json:"strategy_spec_file,omitempty"`

	// The strategy to use for building the image.
	StrategyType *string `json:"strategy_type,omitempty"`

	// The maximum amount of time, in seconds, that can pass before the build must succeed or fail.
	Timeout *int64 `json:"timeout,omitempty"`
}

BuildRun : Response model for build run objects.

type BuildRunList 

type BuildRunList struct {
	// List of all build runs.
	BuildRuns []BuildRun `json:"build_runs" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

BuildRunList : Contains a list of build runs and pagination information.

func (*BuildRunList) GetNextStart 

func (resp *BuildRunList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type BuildRunStatus 

type BuildRunStatus struct {
	// Time the build run completed.
	CompletionTime *string `json:"completion_time,omitempty"`

	// Describes the time the build run completed.
	OutputDigest *string `json:"output_digest,omitempty"`

	// Optional information to provide more context in case of a 'failed' or 'warning' status.
	Reason *string `json:"reason,omitempty"`

	// Time the build run started.
	StartTime *string `json:"start_time,omitempty"`
}

BuildRunStatus : Current status condition of a build run.

type BuildRunsPager 

type BuildRunsPager struct {
	// contains filtered or unexported fields
}

BuildRunsPager can be used to simplify the use of the "ListBuildRuns" method.

func (*BuildRunsPager) GetAll 

func (pager *BuildRunsPager) GetAll() (allItems []BuildRun, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*BuildRunsPager) GetAllWithContext 

func (pager *BuildRunsPager) GetAllWithContext(ctx context.Context) (allItems []BuildRun, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*BuildRunsPager) GetNext 

func (pager *BuildRunsPager) GetNext() (page []BuildRun, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*BuildRunsPager) GetNextWithContext 

func (pager *BuildRunsPager) GetNextWithContext(ctx context.Context) (page []BuildRun, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*BuildRunsPager) HasNext 

func (pager *BuildRunsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type BuildStatus 

type BuildStatus struct {
	// Optional information to provide more context in case of a 'failed' or 'warning' status.
	Reason *string `json:"reason,omitempty"`
}

BuildStatus : The detailed status of the build.

type BuildsPager 

type BuildsPager struct {
	// contains filtered or unexported fields
}

BuildsPager can be used to simplify the use of the "ListBuilds" method.

func (*BuildsPager) GetAll 

func (pager *BuildsPager) GetAll() (allItems []Build, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*BuildsPager) GetAllWithContext 

func (pager *BuildsPager) GetAllWithContext(ctx context.Context) (allItems []Build, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*BuildsPager) GetNext 

func (pager *BuildsPager) GetNext() (page []Build, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*BuildsPager) GetNextWithContext 

func (pager *BuildsPager) GetNextWithContext(ctx context.Context) (page []Build, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*BuildsPager) HasNext 

func (pager *BuildsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type CodeEngineV2 

type CodeEngineV2 struct {
	Service *core.BaseService
}

CodeEngineV2 : REST API for Code Engine

API Version: 2.0.0

func NewCodeEngineV2 

func NewCodeEngineV2(options *CodeEngineV2Options) (service *CodeEngineV2, err error)

NewCodeEngineV2 : constructs an instance of CodeEngineV2 with passed in options.

func NewCodeEngineV2UsingExternalConfig 

func NewCodeEngineV2UsingExternalConfig(options *CodeEngineV2Options) (codeEngine *CodeEngineV2, err error)

NewCodeEngineV2UsingExternalConfig : constructs an instance of CodeEngineV2 with passed in options and external configuration.

func (*CodeEngineV2) Clone 

func (codeEngine *CodeEngineV2) Clone() *CodeEngineV2

Clone makes a copy of "codeEngine" suitable for processing requests.

func (*CodeEngineV2) CreateApp 

func (codeEngine *CodeEngineV2) CreateApp(createAppOptions *CreateAppOptions) (result *App, response *core.DetailedResponse, err error)

CreateApp : Create an application Create an application.

func (*CodeEngineV2) CreateAppWithContext 

func (codeEngine *CodeEngineV2) CreateAppWithContext(ctx context.Context, createAppOptions *CreateAppOptions) (result *App, response *core.DetailedResponse, err error)

CreateAppWithContext is an alternate form of the CreateApp method which supports a Context parameter

func (*CodeEngineV2) CreateBinding 

func (codeEngine *CodeEngineV2) CreateBinding(createBindingOptions *CreateBindingOptions) (result *Binding, response *core.DetailedResponse, err error)

CreateBinding : Create a binding Create a binding. Creating a service binding with a Code Engine app will update the app, creating a new revision. For more information see the [documentaion](https://cloud.ibm.com/docs/codeengine?topic=codeengine-service-binding).

func (*CodeEngineV2) CreateBindingWithContext 

func (codeEngine *CodeEngineV2) CreateBindingWithContext(ctx context.Context, createBindingOptions *CreateBindingOptions) (result *Binding, response *core.DetailedResponse, err error)

CreateBindingWithContext is an alternate form of the CreateBinding method which supports a Context parameter

func (*CodeEngineV2) CreateBuild 

func (codeEngine *CodeEngineV2) CreateBuild(createBuildOptions *CreateBuildOptions) (result *Build, response *core.DetailedResponse, err error)

CreateBuild : Create a build Create a build.

func (*CodeEngineV2) CreateBuildRun 

func (codeEngine *CodeEngineV2) CreateBuildRun(createBuildRunOptions *CreateBuildRunOptions) (result *BuildRun, response *core.DetailedResponse, err error)

CreateBuildRun : Create a build run Create a build run.

func (*CodeEngineV2) CreateBuildRunWithContext 

func (codeEngine *CodeEngineV2) CreateBuildRunWithContext(ctx context.Context, createBuildRunOptions *CreateBuildRunOptions) (result *BuildRun, response *core.DetailedResponse, err error)

CreateBuildRunWithContext is an alternate form of the CreateBuildRun method which supports a Context parameter

func (*CodeEngineV2) CreateBuildWithContext 

func (codeEngine *CodeEngineV2) CreateBuildWithContext(ctx context.Context, createBuildOptions *CreateBuildOptions) (result *Build, response *core.DetailedResponse, err error)

CreateBuildWithContext is an alternate form of the CreateBuild method which supports a Context parameter

func (*CodeEngineV2) CreateConfigMap 

func (codeEngine *CodeEngineV2) CreateConfigMap(createConfigMapOptions *CreateConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

CreateConfigMap : Create a config map Create a config map.

func (*CodeEngineV2) CreateConfigMapWithContext 

func (codeEngine *CodeEngineV2) CreateConfigMapWithContext(ctx context.Context, createConfigMapOptions *CreateConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

CreateConfigMapWithContext is an alternate form of the CreateConfigMap method which supports a Context parameter

func (*CodeEngineV2) CreateDomainMapping 

func (codeEngine *CodeEngineV2) CreateDomainMapping(createDomainMappingOptions *CreateDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

CreateDomainMapping : Create a domain mapping Create a domain mapping.

func (*CodeEngineV2) CreateDomainMappingWithContext 

func (codeEngine *CodeEngineV2) CreateDomainMappingWithContext(ctx context.Context, createDomainMappingOptions *CreateDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

CreateDomainMappingWithContext is an alternate form of the CreateDomainMapping method which supports a Context parameter

func (*CodeEngineV2) CreateJob 

func (codeEngine *CodeEngineV2) CreateJob(createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)

CreateJob : Create a job Create a job.

func (*CodeEngineV2) CreateJobRun 

func (codeEngine *CodeEngineV2) CreateJobRun(createJobRunOptions *CreateJobRunOptions) (result *JobRun, response *core.DetailedResponse, err error)

CreateJobRun : Create a job run Create an job run.

func (*CodeEngineV2) CreateJobRunWithContext 

func (codeEngine *CodeEngineV2) CreateJobRunWithContext(ctx context.Context, createJobRunOptions *CreateJobRunOptions) (result *JobRun, response *core.DetailedResponse, err error)

CreateJobRunWithContext is an alternate form of the CreateJobRun method which supports a Context parameter

func (*CodeEngineV2) CreateJobWithContext 

func (codeEngine *CodeEngineV2) CreateJobWithContext(ctx context.Context, createJobOptions *CreateJobOptions) (result *Job, response *core.DetailedResponse, err error)

CreateJobWithContext is an alternate form of the CreateJob method which supports a Context parameter

func (*CodeEngineV2) CreateProject 

func (codeEngine *CodeEngineV2) CreateProject(createProjectOptions *CreateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

CreateProject : Create a project Create a Code Engine project on IBM Cloud. The project will be created in the region that corresponds to the API endpoint that is being called.

func (*CodeEngineV2) CreateProjectWithContext 

func (codeEngine *CodeEngineV2) CreateProjectWithContext(ctx context.Context, createProjectOptions *CreateProjectOptions) (result *Project, response *core.DetailedResponse, err error)

CreateProjectWithContext is an alternate form of the CreateProject method which supports a Context parameter

func (*CodeEngineV2) CreateSecret 

func (codeEngine *CodeEngineV2) CreateSecret(createSecretOptions *CreateSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

CreateSecret : Create a secret Create a secret.

func (*CodeEngineV2) CreateSecretWithContext 

func (codeEngine *CodeEngineV2) CreateSecretWithContext(ctx context.Context, createSecretOptions *CreateSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

CreateSecretWithContext is an alternate form of the CreateSecret method which supports a Context parameter

func (*CodeEngineV2) DeleteApp 

func (codeEngine *CodeEngineV2) DeleteApp(deleteAppOptions *DeleteAppOptions) (response *core.DetailedResponse, err error)

DeleteApp : Delete an application Delete an application.

func (*CodeEngineV2) DeleteAppRevision 

func (codeEngine *CodeEngineV2) DeleteAppRevision(deleteAppRevisionOptions *DeleteAppRevisionOptions) (response *core.DetailedResponse, err error)

DeleteAppRevision : Delete an application revision Delete an application revision.

func (*CodeEngineV2) DeleteAppRevisionWithContext 

func (codeEngine *CodeEngineV2) DeleteAppRevisionWithContext(ctx context.Context, deleteAppRevisionOptions *DeleteAppRevisionOptions) (response *core.DetailedResponse, err error)

DeleteAppRevisionWithContext is an alternate form of the DeleteAppRevision method which supports a Context parameter

func (*CodeEngineV2) DeleteAppWithContext 

func (codeEngine *CodeEngineV2) DeleteAppWithContext(ctx context.Context, deleteAppOptions *DeleteAppOptions) (response *core.DetailedResponse, err error)

DeleteAppWithContext is an alternate form of the DeleteApp method which supports a Context parameter

func (*CodeEngineV2) DeleteBinding 

func (codeEngine *CodeEngineV2) DeleteBinding(deleteBindingOptions *DeleteBindingOptions) (response *core.DetailedResponse, err error)

DeleteBinding : Delete a binding Delete a binding.

func (*CodeEngineV2) DeleteBindingWithContext 

func (codeEngine *CodeEngineV2) DeleteBindingWithContext(ctx context.Context, deleteBindingOptions *DeleteBindingOptions) (response *core.DetailedResponse, err error)

DeleteBindingWithContext is an alternate form of the DeleteBinding method which supports a Context parameter

func (*CodeEngineV2) DeleteBuild 

func (codeEngine *CodeEngineV2) DeleteBuild(deleteBuildOptions *DeleteBuildOptions) (response *core.DetailedResponse, err error)

DeleteBuild : Delete a build Delete a build.

func (*CodeEngineV2) DeleteBuildRun 

func (codeEngine *CodeEngineV2) DeleteBuildRun(deleteBuildRunOptions *DeleteBuildRunOptions) (response *core.DetailedResponse, err error)

DeleteBuildRun : Delete a build run Delete a build run.

func (*CodeEngineV2) DeleteBuildRunWithContext 

func (codeEngine *CodeEngineV2) DeleteBuildRunWithContext(ctx context.Context, deleteBuildRunOptions *DeleteBuildRunOptions) (response *core.DetailedResponse, err error)

DeleteBuildRunWithContext is an alternate form of the DeleteBuildRun method which supports a Context parameter

func (*CodeEngineV2) DeleteBuildWithContext 

func (codeEngine *CodeEngineV2) DeleteBuildWithContext(ctx context.Context, deleteBuildOptions *DeleteBuildOptions) (response *core.DetailedResponse, err error)

DeleteBuildWithContext is an alternate form of the DeleteBuild method which supports a Context parameter

func (*CodeEngineV2) DeleteConfigMap 

func (codeEngine *CodeEngineV2) DeleteConfigMap(deleteConfigMapOptions *DeleteConfigMapOptions) (response *core.DetailedResponse, err error)

DeleteConfigMap : Delete a config map Delete a config map.

func (*CodeEngineV2) DeleteConfigMapWithContext 

func (codeEngine *CodeEngineV2) DeleteConfigMapWithContext(ctx context.Context, deleteConfigMapOptions *DeleteConfigMapOptions) (response *core.DetailedResponse, err error)

DeleteConfigMapWithContext is an alternate form of the DeleteConfigMap method which supports a Context parameter

func (*CodeEngineV2) DeleteDomainMapping 

func (codeEngine *CodeEngineV2) DeleteDomainMapping(deleteDomainMappingOptions *DeleteDomainMappingOptions) (response *core.DetailedResponse, err error)

DeleteDomainMapping : Delete a domain mapping Delete a domain mapping.

func (*CodeEngineV2) DeleteDomainMappingWithContext 

func (codeEngine *CodeEngineV2) DeleteDomainMappingWithContext(ctx context.Context, deleteDomainMappingOptions *DeleteDomainMappingOptions) (response *core.DetailedResponse, err error)

DeleteDomainMappingWithContext is an alternate form of the DeleteDomainMapping method which supports a Context parameter

func (*CodeEngineV2) DeleteJob 

func (codeEngine *CodeEngineV2) DeleteJob(deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)

DeleteJob : Delete a job Delete a job.

func (*CodeEngineV2) DeleteJobRun 

func (codeEngine *CodeEngineV2) DeleteJobRun(deleteJobRunOptions *DeleteJobRunOptions) (response *core.DetailedResponse, err error)

DeleteJobRun : Delete a job run Delete a job run.

func (*CodeEngineV2) DeleteJobRunWithContext 

func (codeEngine *CodeEngineV2) DeleteJobRunWithContext(ctx context.Context, deleteJobRunOptions *DeleteJobRunOptions) (response *core.DetailedResponse, err error)

DeleteJobRunWithContext is an alternate form of the DeleteJobRun method which supports a Context parameter

func (*CodeEngineV2) DeleteJobWithContext 

func (codeEngine *CodeEngineV2) DeleteJobWithContext(ctx context.Context, deleteJobOptions *DeleteJobOptions) (response *core.DetailedResponse, err error)

DeleteJobWithContext is an alternate form of the DeleteJob method which supports a Context parameter

func (*CodeEngineV2) DeleteProject 

func (codeEngine *CodeEngineV2) DeleteProject(deleteProjectOptions *DeleteProjectOptions) (response *core.DetailedResponse, err error)

DeleteProject : Delete a project Delete a project.

func (*CodeEngineV2) DeleteProjectWithContext 

func (codeEngine *CodeEngineV2) DeleteProjectWithContext(ctx context.Context, deleteProjectOptions *DeleteProjectOptions) (response *core.DetailedResponse, err error)

DeleteProjectWithContext is an alternate form of the DeleteProject method which supports a Context parameter

func (*CodeEngineV2) DeleteSecret 

func (codeEngine *CodeEngineV2) DeleteSecret(deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)

DeleteSecret : Delete a secret Delete a secret.

func (*CodeEngineV2) DeleteSecretWithContext 

func (codeEngine *CodeEngineV2) DeleteSecretWithContext(ctx context.Context, deleteSecretOptions *DeleteSecretOptions) (response *core.DetailedResponse, err error)

DeleteSecretWithContext is an alternate form of the DeleteSecret method which supports a Context parameter

func (*CodeEngineV2) DisableRetries 

func (codeEngine *CodeEngineV2) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*CodeEngineV2) EnableRetries 

func (codeEngine *CodeEngineV2) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*CodeEngineV2) GetApp 

func (codeEngine *CodeEngineV2) GetApp(getAppOptions *GetAppOptions) (result *App, response *core.DetailedResponse, err error)

GetApp : Get an application Display the details of an application.

func (*CodeEngineV2) GetAppRevision 

func (codeEngine *CodeEngineV2) GetAppRevision(getAppRevisionOptions *GetAppRevisionOptions) (result *AppRevision, response *core.DetailedResponse, err error)

GetAppRevision : Get an application revision Display the details of an application revision.

func (*CodeEngineV2) GetAppRevisionWithContext 

func (codeEngine *CodeEngineV2) GetAppRevisionWithContext(ctx context.Context, getAppRevisionOptions *GetAppRevisionOptions) (result *AppRevision, response *core.DetailedResponse, err error)

GetAppRevisionWithContext is an alternate form of the GetAppRevision method which supports a Context parameter

func (*CodeEngineV2) GetAppWithContext 

func (codeEngine *CodeEngineV2) GetAppWithContext(ctx context.Context, getAppOptions *GetAppOptions) (result *App, response *core.DetailedResponse, err error)

GetAppWithContext is an alternate form of the GetApp method which supports a Context parameter

func (*CodeEngineV2) GetBinding 

func (codeEngine *CodeEngineV2) GetBinding(getBindingOptions *GetBindingOptions) (result *Binding, response *core.DetailedResponse, err error)

GetBinding : Get a binding Display the details of a binding.

func (*CodeEngineV2) GetBindingWithContext 

func (codeEngine *CodeEngineV2) GetBindingWithContext(ctx context.Context, getBindingOptions *GetBindingOptions) (result *Binding, response *core.DetailedResponse, err error)

GetBindingWithContext is an alternate form of the GetBinding method which supports a Context parameter

func (*CodeEngineV2) GetBuild 

func (codeEngine *CodeEngineV2) GetBuild(getBuildOptions *GetBuildOptions) (result *Build, response *core.DetailedResponse, err error)

GetBuild : Get a build Display the details of a build.

func (*CodeEngineV2) GetBuildRun 

func (codeEngine *CodeEngineV2) GetBuildRun(getBuildRunOptions *GetBuildRunOptions) (result *BuildRun, response *core.DetailedResponse, err error)

GetBuildRun : Get a build run Display the details of a build run.

func (*CodeEngineV2) GetBuildRunWithContext 

func (codeEngine *CodeEngineV2) GetBuildRunWithContext(ctx context.Context, getBuildRunOptions *GetBuildRunOptions) (result *BuildRun, response *core.DetailedResponse, err error)

GetBuildRunWithContext is an alternate form of the GetBuildRun method which supports a Context parameter

func (*CodeEngineV2) GetBuildWithContext 

func (codeEngine *CodeEngineV2) GetBuildWithContext(ctx context.Context, getBuildOptions *GetBuildOptions) (result *Build, response *core.DetailedResponse, err error)

GetBuildWithContext is an alternate form of the GetBuild method which supports a Context parameter

func (*CodeEngineV2) GetConfigMap 

func (codeEngine *CodeEngineV2) GetConfigMap(getConfigMapOptions *GetConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

GetConfigMap : Get a config map Display the details of a config map.

func (*CodeEngineV2) GetConfigMapWithContext 

func (codeEngine *CodeEngineV2) GetConfigMapWithContext(ctx context.Context, getConfigMapOptions *GetConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

GetConfigMapWithContext is an alternate form of the GetConfigMap method which supports a Context parameter

func (*CodeEngineV2) GetDomainMapping 

func (codeEngine *CodeEngineV2) GetDomainMapping(getDomainMappingOptions *GetDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

GetDomainMapping : Get a domain mapping Get domain mapping.

func (*CodeEngineV2) GetDomainMappingWithContext 

func (codeEngine *CodeEngineV2) GetDomainMappingWithContext(ctx context.Context, getDomainMappingOptions *GetDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

GetDomainMappingWithContext is an alternate form of the GetDomainMapping method which supports a Context parameter

func (*CodeEngineV2) GetEnableGzipCompression 

func (codeEngine *CodeEngineV2) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*CodeEngineV2) GetJob 

func (codeEngine *CodeEngineV2) GetJob(getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)

GetJob : Get a job Display the details of a job.

func (*CodeEngineV2) GetJobRun 

func (codeEngine *CodeEngineV2) GetJobRun(getJobRunOptions *GetJobRunOptions) (result *JobRun, response *core.DetailedResponse, err error)

GetJobRun : Get a job run Display the details of a job run.

func (*CodeEngineV2) GetJobRunWithContext 

func (codeEngine *CodeEngineV2) GetJobRunWithContext(ctx context.Context, getJobRunOptions *GetJobRunOptions) (result *JobRun, response *core.DetailedResponse, err error)

GetJobRunWithContext is an alternate form of the GetJobRun method which supports a Context parameter

func (*CodeEngineV2) GetJobWithContext 

func (codeEngine *CodeEngineV2) GetJobWithContext(ctx context.Context, getJobOptions *GetJobOptions) (result *Job, response *core.DetailedResponse, err error)

GetJobWithContext is an alternate form of the GetJob method which supports a Context parameter

func (*CodeEngineV2) GetProject 

func (codeEngine *CodeEngineV2) GetProject(getProjectOptions *GetProjectOptions) (result *Project, response *core.DetailedResponse, err error)

GetProject : Get a project Display the details of a single project.

func (*CodeEngineV2) GetProjectEgressIps 

func (codeEngine *CodeEngineV2) GetProjectEgressIps(getProjectEgressIpsOptions *GetProjectEgressIpsOptions) (result *ProjectEgressIPAddresses, response *core.DetailedResponse, err error)

GetProjectEgressIps : List egress IP addresses Lists all egress IP addresses (public and private) that are used by components running in this project. For information about using egress IP addresses, see [Code Engine public and private IP addresses](https://cloud.ibm.com/docs/codeengine?topic=codeengine-network-addresses).

func (*CodeEngineV2) GetProjectEgressIpsWithContext 

func (codeEngine *CodeEngineV2) GetProjectEgressIpsWithContext(ctx context.Context, getProjectEgressIpsOptions *GetProjectEgressIpsOptions) (result *ProjectEgressIPAddresses, response *core.DetailedResponse, err error)

GetProjectEgressIpsWithContext is an alternate form of the GetProjectEgressIps method which supports a Context parameter

func (*CodeEngineV2) GetProjectStatusDetails 

func (codeEngine *CodeEngineV2) GetProjectStatusDetails(getProjectStatusDetailsOptions *GetProjectStatusDetailsOptions) (result *ProjectStatusDetails, response *core.DetailedResponse, err error)

GetProjectStatusDetails : Get the status details for a project Retrieves status details about the given project.

func (*CodeEngineV2) GetProjectStatusDetailsWithContext 

func (codeEngine *CodeEngineV2) GetProjectStatusDetailsWithContext(ctx context.Context, getProjectStatusDetailsOptions *GetProjectStatusDetailsOptions) (result *ProjectStatusDetails, response *core.DetailedResponse, err error)

GetProjectStatusDetailsWithContext is an alternate form of the GetProjectStatusDetails method which supports a Context parameter

func (*CodeEngineV2) GetProjectWithContext 

func (codeEngine *CodeEngineV2) GetProjectWithContext(ctx context.Context, getProjectOptions *GetProjectOptions) (result *Project, response *core.DetailedResponse, err error)

GetProjectWithContext is an alternate form of the GetProject method which supports a Context parameter

func (*CodeEngineV2) GetSecret 

func (codeEngine *CodeEngineV2) GetSecret(getSecretOptions *GetSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

GetSecret : Get a secret Get a secret.

func (*CodeEngineV2) GetSecretWithContext 

func (codeEngine *CodeEngineV2) GetSecretWithContext(ctx context.Context, getSecretOptions *GetSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

GetSecretWithContext is an alternate form of the GetSecret method which supports a Context parameter

func (*CodeEngineV2) GetServiceURL 

func (codeEngine *CodeEngineV2) GetServiceURL() string

GetServiceURL returns the service URL

func (*CodeEngineV2) ListAppRevisions 

func (codeEngine *CodeEngineV2) ListAppRevisions(listAppRevisionsOptions *ListAppRevisionsOptions) (result *AppRevisionList, response *core.DetailedResponse, err error)

ListAppRevisions : List application revisions List all application revisions in a particular application.

func (*CodeEngineV2) ListAppRevisionsWithContext 

func (codeEngine *CodeEngineV2) ListAppRevisionsWithContext(ctx context.Context, listAppRevisionsOptions *ListAppRevisionsOptions) (result *AppRevisionList, response *core.DetailedResponse, err error)

ListAppRevisionsWithContext is an alternate form of the ListAppRevisions method which supports a Context parameter

func (*CodeEngineV2) ListApps 

func (codeEngine *CodeEngineV2) ListApps(listAppsOptions *ListAppsOptions) (result *AppList, response *core.DetailedResponse, err error)

ListApps : List applications List all applications in a project.

func (*CodeEngineV2) ListAppsWithContext 

func (codeEngine *CodeEngineV2) ListAppsWithContext(ctx context.Context, listAppsOptions *ListAppsOptions) (result *AppList, response *core.DetailedResponse, err error)

ListAppsWithContext is an alternate form of the ListApps method which supports a Context parameter

func (*CodeEngineV2) ListBindings 

func (codeEngine *CodeEngineV2) ListBindings(listBindingsOptions *ListBindingsOptions) (result *BindingList, response *core.DetailedResponse, err error)

ListBindings : List bindings List all bindings in a project.

func (*CodeEngineV2) ListBindingsWithContext 

func (codeEngine *CodeEngineV2) ListBindingsWithContext(ctx context.Context, listBindingsOptions *ListBindingsOptions) (result *BindingList, response *core.DetailedResponse, err error)

ListBindingsWithContext is an alternate form of the ListBindings method which supports a Context parameter

func (*CodeEngineV2) ListBuildRuns 

func (codeEngine *CodeEngineV2) ListBuildRuns(listBuildRunsOptions *ListBuildRunsOptions) (result *BuildRunList, response *core.DetailedResponse, err error)

ListBuildRuns : List build runs List all build runs in a project.

func (*CodeEngineV2) ListBuildRunsWithContext 

func (codeEngine *CodeEngineV2) ListBuildRunsWithContext(ctx context.Context, listBuildRunsOptions *ListBuildRunsOptions) (result *BuildRunList, response *core.DetailedResponse, err error)

ListBuildRunsWithContext is an alternate form of the ListBuildRuns method which supports a Context parameter

func (*CodeEngineV2) ListBuilds 

func (codeEngine *CodeEngineV2) ListBuilds(listBuildsOptions *ListBuildsOptions) (result *BuildList, response *core.DetailedResponse, err error)

ListBuilds : List builds List all builds in a project.

func (*CodeEngineV2) ListBuildsWithContext 

func (codeEngine *CodeEngineV2) ListBuildsWithContext(ctx context.Context, listBuildsOptions *ListBuildsOptions) (result *BuildList, response *core.DetailedResponse, err error)

ListBuildsWithContext is an alternate form of the ListBuilds method which supports a Context parameter

func (*CodeEngineV2) ListConfigMaps 

func (codeEngine *CodeEngineV2) ListConfigMaps(listConfigMapsOptions *ListConfigMapsOptions) (result *ConfigMapList, response *core.DetailedResponse, err error)

ListConfigMaps : List config maps List all config maps in a project.

func (*CodeEngineV2) ListConfigMapsWithContext 

func (codeEngine *CodeEngineV2) ListConfigMapsWithContext(ctx context.Context, listConfigMapsOptions *ListConfigMapsOptions) (result *ConfigMapList, response *core.DetailedResponse, err error)

ListConfigMapsWithContext is an alternate form of the ListConfigMaps method which supports a Context parameter

func (*CodeEngineV2) ListDomainMappings 

func (codeEngine *CodeEngineV2) ListDomainMappings(listDomainMappingsOptions *ListDomainMappingsOptions) (result *DomainMappingList, response *core.DetailedResponse, err error)

ListDomainMappings : List domain mappings List all domain mappings in a project.

func (*CodeEngineV2) ListDomainMappingsWithContext 

func (codeEngine *CodeEngineV2) ListDomainMappingsWithContext(ctx context.Context, listDomainMappingsOptions *ListDomainMappingsOptions) (result *DomainMappingList, response *core.DetailedResponse, err error)

ListDomainMappingsWithContext is an alternate form of the ListDomainMappings method which supports a Context parameter

func (*CodeEngineV2) ListJobRuns 

func (codeEngine *CodeEngineV2) ListJobRuns(listJobRunsOptions *ListJobRunsOptions) (result *JobRunList, response *core.DetailedResponse, err error)

ListJobRuns : List job runs List all job runs in a project.

func (*CodeEngineV2) ListJobRunsWithContext 

func (codeEngine *CodeEngineV2) ListJobRunsWithContext(ctx context.Context, listJobRunsOptions *ListJobRunsOptions) (result *JobRunList, response *core.DetailedResponse, err error)

ListJobRunsWithContext is an alternate form of the ListJobRuns method which supports a Context parameter

func (*CodeEngineV2) ListJobs 

func (codeEngine *CodeEngineV2) ListJobs(listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)

ListJobs : List jobs List all jobs in a project.

func (*CodeEngineV2) ListJobsWithContext 

func (codeEngine *CodeEngineV2) ListJobsWithContext(ctx context.Context, listJobsOptions *ListJobsOptions) (result *JobList, response *core.DetailedResponse, err error)

ListJobsWithContext is an alternate form of the ListJobs method which supports a Context parameter

func (*CodeEngineV2) ListProjects 

func (codeEngine *CodeEngineV2) ListProjects(listProjectsOptions *ListProjectsOptions) (result *ProjectList, response *core.DetailedResponse, err error)

ListProjects : List all projects List all projects in the current account.

func (*CodeEngineV2) ListProjectsWithContext 

func (codeEngine *CodeEngineV2) ListProjectsWithContext(ctx context.Context, listProjectsOptions *ListProjectsOptions) (result *ProjectList, response *core.DetailedResponse, err error)

ListProjectsWithContext is an alternate form of the ListProjects method which supports a Context parameter

func (*CodeEngineV2) ListSecrets 

func (codeEngine *CodeEngineV2) ListSecrets(listSecretsOptions *ListSecretsOptions) (result *SecretList, response *core.DetailedResponse, err error)

ListSecrets : List secrets List all secrets in a project.

func (*CodeEngineV2) ListSecretsWithContext 

func (codeEngine *CodeEngineV2) ListSecretsWithContext(ctx context.Context, listSecretsOptions *ListSecretsOptions) (result *SecretList, response *core.DetailedResponse, err error)

ListSecretsWithContext is an alternate form of the ListSecrets method which supports a Context parameter

func (*CodeEngineV2) NewAppRevisionsPager 

func (codeEngine *CodeEngineV2) NewAppRevisionsPager(options *ListAppRevisionsOptions) (pager *AppRevisionsPager, err error)

NewAppRevisionsPager returns a new AppRevisionsPager instance.

func (*CodeEngineV2) NewAppsPager 

func (codeEngine *CodeEngineV2) NewAppsPager(options *ListAppsOptions) (pager *AppsPager, err error)

NewAppsPager returns a new AppsPager instance.

func (*CodeEngineV2) NewBindingsPager 

func (codeEngine *CodeEngineV2) NewBindingsPager(options *ListBindingsOptions) (pager *BindingsPager, err error)

NewBindingsPager returns a new BindingsPager instance.

func (*CodeEngineV2) NewBuildRunsPager 

func (codeEngine *CodeEngineV2) NewBuildRunsPager(options *ListBuildRunsOptions) (pager *BuildRunsPager, err error)

NewBuildRunsPager returns a new BuildRunsPager instance.

func (*CodeEngineV2) NewBuildsPager 

func (codeEngine *CodeEngineV2) NewBuildsPager(options *ListBuildsOptions) (pager *BuildsPager, err error)

NewBuildsPager returns a new BuildsPager instance.

func (*CodeEngineV2) NewComponentRef 

func (*CodeEngineV2) NewComponentRef(name string, resourceType string) (_model *ComponentRef, err error)

NewComponentRef : Instantiate ComponentRef (Generic Model Constructor)

func (*CodeEngineV2) NewConfigMapsPager 

func (codeEngine *CodeEngineV2) NewConfigMapsPager(options *ListConfigMapsOptions) (pager *ConfigMapsPager, err error)

NewConfigMapsPager returns a new ConfigMapsPager instance.

func (*CodeEngineV2) NewCreateAppOptions 

func (*CodeEngineV2) NewCreateAppOptions(projectID string, imageReference string, name string) *CreateAppOptions

NewCreateAppOptions : Instantiate CreateAppOptions

func (*CodeEngineV2) NewCreateBindingOptions 

func (*CodeEngineV2) NewCreateBindingOptions(projectID string, component *ComponentRef, prefix string, secretName string) *CreateBindingOptions

NewCreateBindingOptions : Instantiate CreateBindingOptions

func (*CodeEngineV2) NewCreateBuildOptions 

func (*CodeEngineV2) NewCreateBuildOptions(projectID string, name string, outputImage string, outputSecret string, strategyType string) *CreateBuildOptions

NewCreateBuildOptions : Instantiate CreateBuildOptions

func (*CodeEngineV2) NewCreateBuildRunOptions 

func (*CodeEngineV2) NewCreateBuildRunOptions(projectID string) *CreateBuildRunOptions

NewCreateBuildRunOptions : Instantiate CreateBuildRunOptions

func (*CodeEngineV2) NewCreateConfigMapOptions 

func (*CodeEngineV2) NewCreateConfigMapOptions(projectID string, name string) *CreateConfigMapOptions

NewCreateConfigMapOptions : Instantiate CreateConfigMapOptions

func (*CodeEngineV2) NewCreateDomainMappingOptions 

func (*CodeEngineV2) NewCreateDomainMappingOptions(projectID string, component *ComponentRef, name string, tlsSecret string) *CreateDomainMappingOptions

NewCreateDomainMappingOptions : Instantiate CreateDomainMappingOptions

func (*CodeEngineV2) NewCreateJobOptions 

func (*CodeEngineV2) NewCreateJobOptions(projectID string, imageReference string, name string) *CreateJobOptions

NewCreateJobOptions : Instantiate CreateJobOptions

func (*CodeEngineV2) NewCreateJobRunOptions 

func (*CodeEngineV2) NewCreateJobRunOptions(projectID string) *CreateJobRunOptions

NewCreateJobRunOptions : Instantiate CreateJobRunOptions

func (*CodeEngineV2) NewCreateProjectOptions 

func (*CodeEngineV2) NewCreateProjectOptions(name string) *CreateProjectOptions

NewCreateProjectOptions : Instantiate CreateProjectOptions

func (*CodeEngineV2) NewCreateSecretOptions 

func (*CodeEngineV2) NewCreateSecretOptions(projectID string, format string, name string) *CreateSecretOptions

NewCreateSecretOptions : Instantiate CreateSecretOptions

func (*CodeEngineV2) NewDeleteAppOptions 

func (*CodeEngineV2) NewDeleteAppOptions(projectID string, name string) *DeleteAppOptions

NewDeleteAppOptions : Instantiate DeleteAppOptions

func (*CodeEngineV2) NewDeleteAppRevisionOptions 

func (*CodeEngineV2) NewDeleteAppRevisionOptions(projectID string, appName string, name string) *DeleteAppRevisionOptions

NewDeleteAppRevisionOptions : Instantiate DeleteAppRevisionOptions

func (*CodeEngineV2) NewDeleteBindingOptions 

func (*CodeEngineV2) NewDeleteBindingOptions(projectID string, id string) *DeleteBindingOptions

NewDeleteBindingOptions : Instantiate DeleteBindingOptions

func (*CodeEngineV2) NewDeleteBuildOptions 

func (*CodeEngineV2) NewDeleteBuildOptions(projectID string, name string) *DeleteBuildOptions

NewDeleteBuildOptions : Instantiate DeleteBuildOptions

func (*CodeEngineV2) NewDeleteBuildRunOptions 

func (*CodeEngineV2) NewDeleteBuildRunOptions(projectID string, name string) *DeleteBuildRunOptions

NewDeleteBuildRunOptions : Instantiate DeleteBuildRunOptions

func (*CodeEngineV2) NewDeleteConfigMapOptions 

func (*CodeEngineV2) NewDeleteConfigMapOptions(projectID string, name string) *DeleteConfigMapOptions

NewDeleteConfigMapOptions : Instantiate DeleteConfigMapOptions

func (*CodeEngineV2) NewDeleteDomainMappingOptions 

func (*CodeEngineV2) NewDeleteDomainMappingOptions(projectID string, name string) *DeleteDomainMappingOptions

NewDeleteDomainMappingOptions : Instantiate DeleteDomainMappingOptions

func (*CodeEngineV2) NewDeleteJobOptions 

func (*CodeEngineV2) NewDeleteJobOptions(projectID string, name string) *DeleteJobOptions

NewDeleteJobOptions : Instantiate DeleteJobOptions

func (*CodeEngineV2) NewDeleteJobRunOptions 

func (*CodeEngineV2) NewDeleteJobRunOptions(projectID string, name string) *DeleteJobRunOptions

NewDeleteJobRunOptions : Instantiate DeleteJobRunOptions

func (*CodeEngineV2) NewDeleteProjectOptions 

func (*CodeEngineV2) NewDeleteProjectOptions(id string) *DeleteProjectOptions

NewDeleteProjectOptions : Instantiate DeleteProjectOptions

func (*CodeEngineV2) NewDeleteSecretOptions 

func (*CodeEngineV2) NewDeleteSecretOptions(projectID string, name string) *DeleteSecretOptions

NewDeleteSecretOptions : Instantiate DeleteSecretOptions

func (*CodeEngineV2) NewDomainMappingsPager 

func (codeEngine *CodeEngineV2) NewDomainMappingsPager(options *ListDomainMappingsOptions) (pager *DomainMappingsPager, err error)

NewDomainMappingsPager returns a new DomainMappingsPager instance.

func (*CodeEngineV2) NewGetAppOptions 

func (*CodeEngineV2) NewGetAppOptions(projectID string, name string) *GetAppOptions

NewGetAppOptions : Instantiate GetAppOptions

func (*CodeEngineV2) NewGetAppRevisionOptions 

func (*CodeEngineV2) NewGetAppRevisionOptions(projectID string, appName string, name string) *GetAppRevisionOptions

NewGetAppRevisionOptions : Instantiate GetAppRevisionOptions

func (*CodeEngineV2) NewGetBindingOptions 

func (*CodeEngineV2) NewGetBindingOptions(projectID string, id string) *GetBindingOptions

NewGetBindingOptions : Instantiate GetBindingOptions

func (*CodeEngineV2) NewGetBuildOptions 

func (*CodeEngineV2) NewGetBuildOptions(projectID string, name string) *GetBuildOptions

NewGetBuildOptions : Instantiate GetBuildOptions

func (*CodeEngineV2) NewGetBuildRunOptions 

func (*CodeEngineV2) NewGetBuildRunOptions(projectID string, name string) *GetBuildRunOptions

NewGetBuildRunOptions : Instantiate GetBuildRunOptions

func (*CodeEngineV2) NewGetConfigMapOptions 

func (*CodeEngineV2) NewGetConfigMapOptions(projectID string, name string) *GetConfigMapOptions

NewGetConfigMapOptions : Instantiate GetConfigMapOptions

func (*CodeEngineV2) NewGetDomainMappingOptions 

func (*CodeEngineV2) NewGetDomainMappingOptions(projectID string, name string) *GetDomainMappingOptions

NewGetDomainMappingOptions : Instantiate GetDomainMappingOptions

func (*CodeEngineV2) NewGetJobOptions 

func (*CodeEngineV2) NewGetJobOptions(projectID string, name string) *GetJobOptions

NewGetJobOptions : Instantiate GetJobOptions

func (*CodeEngineV2) NewGetJobRunOptions 

func (*CodeEngineV2) NewGetJobRunOptions(projectID string, name string) *GetJobRunOptions

NewGetJobRunOptions : Instantiate GetJobRunOptions

func (*CodeEngineV2) NewGetProjectEgressIpsOptions 

func (*CodeEngineV2) NewGetProjectEgressIpsOptions(projectID string) *GetProjectEgressIpsOptions

NewGetProjectEgressIpsOptions : Instantiate GetProjectEgressIpsOptions

func (*CodeEngineV2) NewGetProjectOptions 

func (*CodeEngineV2) NewGetProjectOptions(id string) *GetProjectOptions

NewGetProjectOptions : Instantiate GetProjectOptions

func (*CodeEngineV2) NewGetProjectStatusDetailsOptions 

func (*CodeEngineV2) NewGetProjectStatusDetailsOptions(projectID string) *GetProjectStatusDetailsOptions

NewGetProjectStatusDetailsOptions : Instantiate GetProjectStatusDetailsOptions

func (*CodeEngineV2) NewGetSecretOptions 

func (*CodeEngineV2) NewGetSecretOptions(projectID string, name string) *GetSecretOptions

NewGetSecretOptions : Instantiate GetSecretOptions

func (*CodeEngineV2) NewJobRunsPager 

func (codeEngine *CodeEngineV2) NewJobRunsPager(options *ListJobRunsOptions) (pager *JobRunsPager, err error)

NewJobRunsPager returns a new JobRunsPager instance.

func (*CodeEngineV2) NewJobsPager 

func (codeEngine *CodeEngineV2) NewJobsPager(options *ListJobsOptions) (pager *JobsPager, err error)

NewJobsPager returns a new JobsPager instance.

func (*CodeEngineV2) NewListAppRevisionsOptions 

func (*CodeEngineV2) NewListAppRevisionsOptions(projectID string, appName string) *ListAppRevisionsOptions

NewListAppRevisionsOptions : Instantiate ListAppRevisionsOptions

func (*CodeEngineV2) NewListAppsOptions 

func (*CodeEngineV2) NewListAppsOptions(projectID string) *ListAppsOptions

NewListAppsOptions : Instantiate ListAppsOptions

func (*CodeEngineV2) NewListBindingsOptions 

func (*CodeEngineV2) NewListBindingsOptions(projectID string) *ListBindingsOptions

NewListBindingsOptions : Instantiate ListBindingsOptions

func (*CodeEngineV2) NewListBuildRunsOptions 

func (*CodeEngineV2) NewListBuildRunsOptions(projectID string) *ListBuildRunsOptions

NewListBuildRunsOptions : Instantiate ListBuildRunsOptions

func (*CodeEngineV2) NewListBuildsOptions 

func (*CodeEngineV2) NewListBuildsOptions(projectID string) *ListBuildsOptions

NewListBuildsOptions : Instantiate ListBuildsOptions

func (*CodeEngineV2) NewListConfigMapsOptions 

func (*CodeEngineV2) NewListConfigMapsOptions(projectID string) *ListConfigMapsOptions

NewListConfigMapsOptions : Instantiate ListConfigMapsOptions

func (*CodeEngineV2) NewListDomainMappingsOptions 

func (*CodeEngineV2) NewListDomainMappingsOptions(projectID string) *ListDomainMappingsOptions

NewListDomainMappingsOptions : Instantiate ListDomainMappingsOptions

func (*CodeEngineV2) NewListJobRunsOptions 

func (*CodeEngineV2) NewListJobRunsOptions(projectID string) *ListJobRunsOptions

NewListJobRunsOptions : Instantiate ListJobRunsOptions

func (*CodeEngineV2) NewListJobsOptions 

func (*CodeEngineV2) NewListJobsOptions(projectID string) *ListJobsOptions

NewListJobsOptions : Instantiate ListJobsOptions

func (*CodeEngineV2) NewListProjectsOptions 

func (*CodeEngineV2) NewListProjectsOptions() *ListProjectsOptions

NewListProjectsOptions : Instantiate ListProjectsOptions

func (*CodeEngineV2) NewListSecretsOptions 

func (*CodeEngineV2) NewListSecretsOptions(projectID string) *ListSecretsOptions

NewListSecretsOptions : Instantiate ListSecretsOptions

func (*CodeEngineV2) NewProjectsPager 

func (codeEngine *CodeEngineV2) NewProjectsPager(options *ListProjectsOptions) (pager *ProjectsPager, err error)

NewProjectsPager returns a new ProjectsPager instance.

func (*CodeEngineV2) NewReplaceConfigMapOptions 

func (*CodeEngineV2) NewReplaceConfigMapOptions(projectID string, name string, ifMatch string) *ReplaceConfigMapOptions

NewReplaceConfigMapOptions : Instantiate ReplaceConfigMapOptions

func (*CodeEngineV2) NewReplaceSecretOptions 

func (*CodeEngineV2) NewReplaceSecretOptions(projectID string, name string, ifMatch string, format string) *ReplaceSecretOptions

NewReplaceSecretOptions : Instantiate ReplaceSecretOptions

func (*CodeEngineV2) NewSecretDataBasicAuthSecretData 

func (*CodeEngineV2) NewSecretDataBasicAuthSecretData(username string, password string) (_model *SecretDataBasicAuthSecretData, err error)

NewSecretDataBasicAuthSecretData : Instantiate SecretDataBasicAuthSecretData (Generic Model Constructor)

func (*CodeEngineV2) NewSecretDataRegistrySecretData 

func (*CodeEngineV2) NewSecretDataRegistrySecretData(username string, password string, server string, email string) (_model *SecretDataRegistrySecretData, err error)

NewSecretDataRegistrySecretData : Instantiate SecretDataRegistrySecretData (Generic Model Constructor)

func (*CodeEngineV2) NewSecretDataSSHSecretData 

func (*CodeEngineV2) NewSecretDataSSHSecretData(sshKey string) (_model *SecretDataSSHSecretData, err error)

NewSecretDataSSHSecretData : Instantiate SecretDataSSHSecretData (Generic Model Constructor)

func (*CodeEngineV2) NewSecretDataTLSSecretData 

func (*CodeEngineV2) NewSecretDataTLSSecretData(tlsCert string, tlsKey string) (_model *SecretDataTLSSecretData, err error)

NewSecretDataTLSSecretData : Instantiate SecretDataTLSSecretData (Generic Model Constructor)

func (*CodeEngineV2) NewSecretsPager 

func (codeEngine *CodeEngineV2) NewSecretsPager(options *ListSecretsOptions) (pager *SecretsPager, err error)

NewSecretsPager returns a new SecretsPager instance.

func (*CodeEngineV2) NewServiceAccessSecretPrototypeProps 

func (*CodeEngineV2) NewServiceAccessSecretPrototypeProps(resourceKey *ResourceKeyRefPrototype, serviceInstance *ServiceInstanceRefPrototype) (_model *ServiceAccessSecretPrototypeProps, err error)

NewServiceAccessSecretPrototypeProps : Instantiate ServiceAccessSecretPrototypeProps (Generic Model Constructor)

func (*CodeEngineV2) NewUpdateAppOptions 

func (*CodeEngineV2) NewUpdateAppOptions(projectID string, name string, ifMatch string, app map[string]interface{}) *UpdateAppOptions

NewUpdateAppOptions : Instantiate UpdateAppOptions

func (*CodeEngineV2) NewUpdateBuildOptions 

func (*CodeEngineV2) NewUpdateBuildOptions(projectID string, name string, ifMatch string, build map[string]interface{}) *UpdateBuildOptions

NewUpdateBuildOptions : Instantiate UpdateBuildOptions

func (*CodeEngineV2) NewUpdateDomainMappingOptions 

func (*CodeEngineV2) NewUpdateDomainMappingOptions(projectID string, name string, ifMatch string, domainMapping map[string]interface{}) *UpdateDomainMappingOptions

NewUpdateDomainMappingOptions : Instantiate UpdateDomainMappingOptions

func (*CodeEngineV2) NewUpdateJobOptions 

func (*CodeEngineV2) NewUpdateJobOptions(projectID string, name string, ifMatch string, job map[string]interface{}) *UpdateJobOptions

NewUpdateJobOptions : Instantiate UpdateJobOptions

func (*CodeEngineV2) NewVolumeMountPrototype 

func (*CodeEngineV2) NewVolumeMountPrototype(mountPath string, reference string, typeVar string) (_model *VolumeMountPrototype, err error)

NewVolumeMountPrototype : Instantiate VolumeMountPrototype (Generic Model Constructor)

func (*CodeEngineV2) ReplaceConfigMap 

func (codeEngine *CodeEngineV2) ReplaceConfigMap(replaceConfigMapOptions *ReplaceConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

ReplaceConfigMap : Update a config map Update a config map.

func (*CodeEngineV2) ReplaceConfigMapWithContext 

func (codeEngine *CodeEngineV2) ReplaceConfigMapWithContext(ctx context.Context, replaceConfigMapOptions *ReplaceConfigMapOptions) (result *ConfigMap, response *core.DetailedResponse, err error)

ReplaceConfigMapWithContext is an alternate form of the ReplaceConfigMap method which supports a Context parameter

func (*CodeEngineV2) ReplaceSecret 

func (codeEngine *CodeEngineV2) ReplaceSecret(replaceSecretOptions *ReplaceSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

ReplaceSecret : Update a secret Update a secret.

func (*CodeEngineV2) ReplaceSecretWithContext 

func (codeEngine *CodeEngineV2) ReplaceSecretWithContext(ctx context.Context, replaceSecretOptions *ReplaceSecretOptions) (result *Secret, response *core.DetailedResponse, err error)

ReplaceSecretWithContext is an alternate form of the ReplaceSecret method which supports a Context parameter

func (*CodeEngineV2) SetDefaultHeaders 

func (codeEngine *CodeEngineV2) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*CodeEngineV2) SetEnableGzipCompression 

func (codeEngine *CodeEngineV2) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*CodeEngineV2) SetServiceURL 

func (codeEngine *CodeEngineV2) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*CodeEngineV2) UpdateApp 

func (codeEngine *CodeEngineV2) UpdateApp(updateAppOptions *UpdateAppOptions) (result *App, response *core.DetailedResponse, err error)

UpdateApp : Update an application An application contains one or more revisions. A revision represents an immutable version of the configuration properties of the application. Each update of an application configuration property creates a new revision of the application. [Learn more](https://cloud.ibm.com/docs/codeengine?topic=codeengine-update-app).

func (*CodeEngineV2) UpdateAppWithContext 

func (codeEngine *CodeEngineV2) UpdateAppWithContext(ctx context.Context, updateAppOptions *UpdateAppOptions) (result *App, response *core.DetailedResponse, err error)

UpdateAppWithContext is an alternate form of the UpdateApp method which supports a Context parameter

func (*CodeEngineV2) UpdateBuild 

func (codeEngine *CodeEngineV2) UpdateBuild(updateBuildOptions *UpdateBuildOptions) (result *Build, response *core.DetailedResponse, err error)

UpdateBuild : Update a build Update a build.

func (*CodeEngineV2) UpdateBuildWithContext 

func (codeEngine *CodeEngineV2) UpdateBuildWithContext(ctx context.Context, updateBuildOptions *UpdateBuildOptions) (result *Build, response *core.DetailedResponse, err error)

UpdateBuildWithContext is an alternate form of the UpdateBuild method which supports a Context parameter

func (*CodeEngineV2) UpdateDomainMapping 

func (codeEngine *CodeEngineV2) UpdateDomainMapping(updateDomainMappingOptions *UpdateDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

UpdateDomainMapping : Update a domain mapping Update a domain mapping.

func (*CodeEngineV2) UpdateDomainMappingWithContext 

func (codeEngine *CodeEngineV2) UpdateDomainMappingWithContext(ctx context.Context, updateDomainMappingOptions *UpdateDomainMappingOptions) (result *DomainMapping, response *core.DetailedResponse, err error)

UpdateDomainMappingWithContext is an alternate form of the UpdateDomainMapping method which supports a Context parameter

func (*CodeEngineV2) UpdateJob 

func (codeEngine *CodeEngineV2) UpdateJob(updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)

UpdateJob : Update a job Update the given job.

func (*CodeEngineV2) UpdateJobWithContext 

func (codeEngine *CodeEngineV2) UpdateJobWithContext(ctx context.Context, updateJobOptions *UpdateJobOptions) (result *Job, response *core.DetailedResponse, err error)

UpdateJobWithContext is an alternate form of the UpdateJob method which supports a Context parameter

type CodeEngineV2Options 

type CodeEngineV2Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

CodeEngineV2Options : Service options

type ComponentRef 

type ComponentRef struct {
	// The name of the referenced component.
	Name *string `json:"name" validate:"required"`

	// The type of the referenced resource.
	ResourceType *string `json:"resource_type" validate:"required"`
}

ComponentRef : A reference to another component.

type ConfigMap 

type ConfigMap struct {
	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// The key-value pair for the config map. Values must be specified in `KEY=VALUE` format.
	Data map[string]string `json:"data,omitempty"`

	// The version of the config map instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// When you provision a new config map,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the config map.
	Name *string `json:"name" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the config map.
	ResourceType *string `json:"resource_type,omitempty"`
}

ConfigMap : Describes the model of a configmap.

type ConfigMapList 

type ConfigMapList struct {
	// List of all configmaps.
	ConfigMaps []ConfigMap `json:"config_maps" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

ConfigMapList : Contains a list of configmaps and pagination information.

func (*ConfigMapList) GetNextStart 

func (resp *ConfigMapList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ConfigMapsPager 

type ConfigMapsPager struct {
	// contains filtered or unexported fields
}

ConfigMapsPager can be used to simplify the use of the "ListConfigMaps" method.

func (*ConfigMapsPager) GetAll 

func (pager *ConfigMapsPager) GetAll() (allItems []ConfigMap, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ConfigMapsPager) GetAllWithContext 

func (pager *ConfigMapsPager) GetAllWithContext(ctx context.Context) (allItems []ConfigMap, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ConfigMapsPager) GetNext 

func (pager *ConfigMapsPager) GetNext() (page []ConfigMap, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ConfigMapsPager) GetNextWithContext 

func (pager *ConfigMapsPager) GetNextWithContext(ctx context.Context) (page []ConfigMap, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ConfigMapsPager) HasNext 

func (pager *ConfigMapsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type CreateAppOptions 

type CreateAppOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of the image that is used for this app. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference" validate:"required"`

	// The name of the app. Use a name that is unique within the project.
	Name *string `json:"name" validate:"required"`

	// Optional port the app listens on. While the app will always be exposed via port `443` for end users, this port is
	// used to connect to the port that is exposed by the container image.
	ImagePort *int64 `json:"image_port,omitempty"`

	// Optional name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the app will be created but cannot reach the ready status, until this property is provided, too.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Optional value controlling which of the system managed domain mappings will be setup for the application. Valid
	// values are 'local_public', 'local_private' and 'local'. Visibility can only be 'local_private' if the project
	// supports application private visibility.
	ManagedDomainMappings *string `json:"managed_domain_mappings,omitempty"`

	// Request model for probes.
	ProbeLiveness *ProbePrototype `json:"probe_liveness,omitempty"`

	// Request model for probes.
	ProbeReadiness *ProbePrototype `json:"probe_readiness,omitempty"`

	// Optional arguments for the app that are passed to start the container. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments,omitempty"`

	// Optional user ID (UID) to run the app (e.g., `1001`).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Optional commands for the app that are passed to start the container. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands,omitempty"`

	// Optional references to config maps, secrets or literal values that are exposed as environment variables within the
	// running application.
	RunEnvVariables []EnvVarPrototype `json:"run_env_variables,omitempty"`

	// Optional name of the service account. For built-in service accounts, you can use the shortened names `manager` ,
	// `none`, `reader`, and `writer`.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets.
	RunVolumeMounts []VolumeMountPrototype `json:"run_volume_mounts,omitempty"`

	// Optional maximum number of requests that can be processed concurrently per instance.
	ScaleConcurrency *int64 `json:"scale_concurrency,omitempty"`

	// Optional threshold of concurrent requests per instance at which one or more additional instances are created. Use
	// this value to scale up instances based on concurrent number of requests. This option defaults to the value of the
	// `scale_concurrency` option, if not specified.
	ScaleConcurrencyTarget *int64 `json:"scale_concurrency_target,omitempty"`

	// Optional number of CPU set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of time in seconds that delays the scale down behavior for an app instance.
	ScaleDownDelay *int64 `json:"scale_down_delay,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the app. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// Optional initial number of instances that are created upon app creation or app update.
	ScaleInitialInstances *int64 `json:"scale_initial_instances,omitempty"`

	// Optional maximum number of instances for this app. If you set this value to `0`, this property does not set a upper
	// scaling limit. However, the app scaling is still limited by the project quota for instances. See [Limits and quotas
	// for Code Engine](https://cloud.ibm.com/docs/codeengine?topic=codeengine-limits).
	ScaleMaxInstances *int64 `json:"scale_max_instances,omitempty"`

	// Optional amount of memory set for the instance of the app. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// Optional minimum number of instances for this app. If you set this value to `0`, the app will scale down to zero, if
	// not hit by any request for some time.
	ScaleMinInstances *int64 `json:"scale_min_instances,omitempty"`

	// Optional amount of time in seconds that is allowed for a running app to respond to a request.
	ScaleRequestTimeout *int64 `json:"scale_request_timeout,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateAppOptions : The CreateApp options.

func (*CreateAppOptions) SetHeaders 

func (options *CreateAppOptions) SetHeaders(param map[string]string) *CreateAppOptions

SetHeaders : Allow user to set Headers

func (*CreateAppOptions) SetImagePort 

func (_options *CreateAppOptions) SetImagePort(imagePort int64) *CreateAppOptions

SetImagePort : Allow user to set ImagePort

func (*CreateAppOptions) SetImageReference 

func (_options *CreateAppOptions) SetImageReference(imageReference string) *CreateAppOptions

SetImageReference : Allow user to set ImageReference

func (*CreateAppOptions) SetImageSecret 

func (_options *CreateAppOptions) SetImageSecret(imageSecret string) *CreateAppOptions

SetImageSecret : Allow user to set ImageSecret

func (*CreateAppOptions) SetManagedDomainMappings 

func (_options *CreateAppOptions) SetManagedDomainMappings(managedDomainMappings string) *CreateAppOptions

SetManagedDomainMappings : Allow user to set ManagedDomainMappings

func (*CreateAppOptions) SetName 

func (_options *CreateAppOptions) SetName(name string) *CreateAppOptions

SetName : Allow user to set Name

func (*CreateAppOptions) SetProbeLiveness 

func (_options *CreateAppOptions) SetProbeLiveness(probeLiveness *ProbePrototype) *CreateAppOptions

SetProbeLiveness : Allow user to set ProbeLiveness

func (*CreateAppOptions) SetProbeReadiness 

func (_options *CreateAppOptions) SetProbeReadiness(probeReadiness *ProbePrototype) *CreateAppOptions

SetProbeReadiness : Allow user to set ProbeReadiness

func (*CreateAppOptions) SetProjectID 

func (_options *CreateAppOptions) SetProjectID(projectID string) *CreateAppOptions

SetProjectID : Allow user to set ProjectID

func (*CreateAppOptions) SetRunArguments 

func (_options *CreateAppOptions) SetRunArguments(runArguments []string) *CreateAppOptions

SetRunArguments : Allow user to set RunArguments

func (*CreateAppOptions) SetRunAsUser 

func (_options *CreateAppOptions) SetRunAsUser(runAsUser int64) *CreateAppOptions

SetRunAsUser : Allow user to set RunAsUser

func (*CreateAppOptions) SetRunCommands 

func (_options *CreateAppOptions) SetRunCommands(runCommands []string) *CreateAppOptions

SetRunCommands : Allow user to set RunCommands

func (*CreateAppOptions) SetRunEnvVariables 

func (_options *CreateAppOptions) SetRunEnvVariables(runEnvVariables []EnvVarPrototype) *CreateAppOptions

SetRunEnvVariables : Allow user to set RunEnvVariables

func (*CreateAppOptions) SetRunServiceAccount 

func (_options *CreateAppOptions) SetRunServiceAccount(runServiceAccount string) *CreateAppOptions

SetRunServiceAccount : Allow user to set RunServiceAccount

func (*CreateAppOptions) SetRunVolumeMounts 

func (_options *CreateAppOptions) SetRunVolumeMounts(runVolumeMounts []VolumeMountPrototype) *CreateAppOptions

SetRunVolumeMounts : Allow user to set RunVolumeMounts

func (*CreateAppOptions) SetScaleConcurrency 

func (_options *CreateAppOptions) SetScaleConcurrency(scaleConcurrency int64) *CreateAppOptions

SetScaleConcurrency : Allow user to set ScaleConcurrency

func (*CreateAppOptions) SetScaleConcurrencyTarget 

func (_options *CreateAppOptions) SetScaleConcurrencyTarget(scaleConcurrencyTarget int64) *CreateAppOptions

SetScaleConcurrencyTarget : Allow user to set ScaleConcurrencyTarget

func (*CreateAppOptions) SetScaleCpuLimit 

func (_options *CreateAppOptions) SetScaleCpuLimit(scaleCpuLimit string) *CreateAppOptions

SetScaleCpuLimit : Allow user to set ScaleCpuLimit

func (*CreateAppOptions) SetScaleDownDelay 

func (_options *CreateAppOptions) SetScaleDownDelay(scaleDownDelay int64) *CreateAppOptions

SetScaleDownDelay : Allow user to set ScaleDownDelay

func (*CreateAppOptions) SetScaleEphemeralStorageLimit 

func (_options *CreateAppOptions) SetScaleEphemeralStorageLimit(scaleEphemeralStorageLimit string) *CreateAppOptions

SetScaleEphemeralStorageLimit : Allow user to set ScaleEphemeralStorageLimit

func (*CreateAppOptions) SetScaleInitialInstances 

func (_options *CreateAppOptions) SetScaleInitialInstances(scaleInitialInstances int64) *CreateAppOptions

SetScaleInitialInstances : Allow user to set ScaleInitialInstances

func (*CreateAppOptions) SetScaleMaxInstances 

func (_options *CreateAppOptions) SetScaleMaxInstances(scaleMaxInstances int64) *CreateAppOptions

SetScaleMaxInstances : Allow user to set ScaleMaxInstances

func (*CreateAppOptions) SetScaleMemoryLimit 

func (_options *CreateAppOptions) SetScaleMemoryLimit(scaleMemoryLimit string) *CreateAppOptions

SetScaleMemoryLimit : Allow user to set ScaleMemoryLimit

func (*CreateAppOptions) SetScaleMinInstances 

func (_options *CreateAppOptions) SetScaleMinInstances(scaleMinInstances int64) *CreateAppOptions

SetScaleMinInstances : Allow user to set ScaleMinInstances

func (*CreateAppOptions) SetScaleRequestTimeout 

func (_options *CreateAppOptions) SetScaleRequestTimeout(scaleRequestTimeout int64) *CreateAppOptions

SetScaleRequestTimeout : Allow user to set ScaleRequestTimeout

type CreateBindingOptions 

type CreateBindingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// A reference to another component.
	Component *ComponentRef `json:"component" validate:"required"`

	// Optional value that is set as prefix in the component that is bound. Will be generated if not provided.
	Prefix *string `json:"prefix" validate:"required"`

	// The service access secret that is binding to a component.
	SecretName *string `json:"secret_name" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateBindingOptions : The CreateBinding options.

func (*CreateBindingOptions) SetComponent 

func (_options *CreateBindingOptions) SetComponent(component *ComponentRef) *CreateBindingOptions

SetComponent : Allow user to set Component

func (*CreateBindingOptions) SetHeaders 

func (options *CreateBindingOptions) SetHeaders(param map[string]string) *CreateBindingOptions

SetHeaders : Allow user to set Headers

func (*CreateBindingOptions) SetPrefix 

func (_options *CreateBindingOptions) SetPrefix(prefix string) *CreateBindingOptions

SetPrefix : Allow user to set Prefix

func (*CreateBindingOptions) SetProjectID 

func (_options *CreateBindingOptions) SetProjectID(projectID string) *CreateBindingOptions

SetProjectID : Allow user to set ProjectID

func (*CreateBindingOptions) SetSecretName 

func (_options *CreateBindingOptions) SetSecretName(secretName string) *CreateBindingOptions

SetSecretName : Allow user to set SecretName

type CreateBuildOptions 

type CreateBuildOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of the build. Use a name that is unique within the project.
	Name *string `json:"name" validate:"required"`

	// The name of the image.
	OutputImage *string `json:"output_image" validate:"required"`

	// The secret that is required to access the image registry. Make sure that the secret is granted with push permissions
	// towards the specified container registry namespace.
	OutputSecret *string `json:"output_secret" validate:"required"`

	// The strategy to use for building the image.
	StrategyType *string `json:"strategy_type" validate:"required"`

	// Option directory in the repository that contains the buildpacks file or the Dockerfile.
	SourceContextDir *string `json:"source_context_dir,omitempty"`

	// Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and
	// uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.
	SourceRevision *string `json:"source_revision,omitempty"`

	// Name of the secret that is used access the repository source. This field is optional if the `source_type` is `git`.
	// Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but
	// cannot access any source code, until this property is provided, too. If the `source_type` value is `local`, this
	// field must be omitted.
	SourceSecret *string `json:"source_secret,omitempty"`

	// Specifies the type of source to determine if your build source is in a repository or based on local source code.
	// * local - For builds from local source code.
	// * git - For builds from git version controlled source code.
	SourceType *string `json:"source_type,omitempty"`

	// The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is
	// `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like
	// `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like
	// `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.
	SourceURL *string `json:"source_url,omitempty"`

	// Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`,
	// `large`, `xlarge`, `xxlarge`.
	StrategySize *string `json:"strategy_size,omitempty"`

	// Optional path to the specification file that is used for build strategies for building an image.
	StrategySpecFile *string `json:"strategy_spec_file,omitempty"`

	// The maximum amount of time, in seconds, that can pass before the build must succeed or fail.
	Timeout *int64 `json:"timeout,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateBuildOptions : The CreateBuild options.

func (*CreateBuildOptions) SetHeaders 

func (options *CreateBuildOptions) SetHeaders(param map[string]string) *CreateBuildOptions

SetHeaders : Allow user to set Headers

func (*CreateBuildOptions) SetName 

func (_options *CreateBuildOptions) SetName(name string) *CreateBuildOptions

SetName : Allow user to set Name

func (*CreateBuildOptions) SetOutputImage 

func (_options *CreateBuildOptions) SetOutputImage(outputImage string) *CreateBuildOptions

SetOutputImage : Allow user to set OutputImage

func (*CreateBuildOptions) SetOutputSecret 

func (_options *CreateBuildOptions) SetOutputSecret(outputSecret string) *CreateBuildOptions

SetOutputSecret : Allow user to set OutputSecret

func (*CreateBuildOptions) SetProjectID 

func (_options *CreateBuildOptions) SetProjectID(projectID string) *CreateBuildOptions

SetProjectID : Allow user to set ProjectID

func (*CreateBuildOptions) SetSourceContextDir 

func (_options *CreateBuildOptions) SetSourceContextDir(sourceContextDir string) *CreateBuildOptions

SetSourceContextDir : Allow user to set SourceContextDir

func (*CreateBuildOptions) SetSourceRevision 

func (_options *CreateBuildOptions) SetSourceRevision(sourceRevision string) *CreateBuildOptions

SetSourceRevision : Allow user to set SourceRevision

func (*CreateBuildOptions) SetSourceSecret 

func (_options *CreateBuildOptions) SetSourceSecret(sourceSecret string) *CreateBuildOptions

SetSourceSecret : Allow user to set SourceSecret

func (*CreateBuildOptions) SetSourceType 

func (_options *CreateBuildOptions) SetSourceType(sourceType string) *CreateBuildOptions

SetSourceType : Allow user to set SourceType

func (*CreateBuildOptions) SetSourceURL 

func (_options *CreateBuildOptions) SetSourceURL(sourceURL string) *CreateBuildOptions

SetSourceURL : Allow user to set SourceURL

func (*CreateBuildOptions) SetStrategySize 

func (_options *CreateBuildOptions) SetStrategySize(strategySize string) *CreateBuildOptions

SetStrategySize : Allow user to set StrategySize

func (*CreateBuildOptions) SetStrategySpecFile 

func (_options *CreateBuildOptions) SetStrategySpecFile(strategySpecFile string) *CreateBuildOptions

SetStrategySpecFile : Allow user to set StrategySpecFile

func (*CreateBuildOptions) SetStrategyType 

func (_options *CreateBuildOptions) SetStrategyType(strategyType string) *CreateBuildOptions

SetStrategyType : Allow user to set StrategyType

func (*CreateBuildOptions) SetTimeout 

func (_options *CreateBuildOptions) SetTimeout(timeout int64) *CreateBuildOptions

SetTimeout : Allow user to set Timeout

type CreateBuildRunOptions 

type CreateBuildRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional name of the build on which this build run is based on. If specified, the build run will inherit the
	// configuration of the referenced build. If not specified, make sure to specify at least the fields `strategy_type`,
	// `source_url`, `output_image` and `output_secret` to describe the build run.
	BuildName *string `json:"build_name,omitempty"`

	// Name of the build run. This field is optional, if the field `build_name` is specified and its value will be
	// generated like so: `[BUILD_NAME]-run-[timestamp with format: YYMMDD-hhmmss] if not set.`.
	Name *string `json:"name,omitempty"`

	// The name of the image.
	OutputImage *string `json:"output_image,omitempty"`

	// The secret that is required to access the image registry. Make sure that the secret is granted with push permissions
	// towards the specified container registry namespace.
	OutputSecret *string `json:"output_secret,omitempty"`

	// Optional service account which is used for resource control.
	ServiceAccount *string `json:"service_account,omitempty"`

	// Option directory in the repository that contains the buildpacks file or the Dockerfile.
	SourceContextDir *string `json:"source_context_dir,omitempty"`

	// Commit, tag, or branch in the source repository to pull. This field is optional if the `source_type` is `git` and
	// uses the HEAD of default branch if not specified. If the `source_type` value is `local`, this field must be omitted.
	SourceRevision *string `json:"source_revision,omitempty"`

	// Name of the secret that is used access the repository source. This field is optional if the `source_type` is `git`.
	// Additionally, if the `source_url` points to a repository that requires authentication, the build will be created but
	// cannot access any source code, until this property is provided, too. If the `source_type` value is `local`, this
	// field must be omitted.
	SourceSecret *string `json:"source_secret,omitempty"`

	// Specifies the type of source to determine if your build source is in a repository or based on local source code.
	// * local - For builds from local source code.
	// * git - For builds from git version controlled source code.
	SourceType *string `json:"source_type,omitempty"`

	// The URL of the code repository. This field is required if the `source_type` is `git`. If the `source_type` value is
	// `local`, this field must be omitted. If the repository is publicly available you can provide a 'https' URL like
	// `https://github.com/IBM/CodeEngine`. If the repository requires authentication, you need to provide a 'ssh' URL like
	// `git@github.com:IBM/CodeEngine.git` along with a `source_secret` that points to a secret of format `ssh_auth`.
	SourceURL *string `json:"source_url,omitempty"`

	// Optional size for the build, which determines the amount of resources used. Build sizes are `small`, `medium`,
	// `large`, `xlarge`, `xxlarge`.
	StrategySize *string `json:"strategy_size,omitempty"`

	// Optional path to the specification file that is used for build strategies for building an image.
	StrategySpecFile *string `json:"strategy_spec_file,omitempty"`

	// The strategy to use for building the image.
	StrategyType *string `json:"strategy_type,omitempty"`

	// The maximum amount of time, in seconds, that can pass before the build must succeed or fail.
	Timeout *int64 `json:"timeout,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateBuildRunOptions : The CreateBuildRun options.

func (*CreateBuildRunOptions) SetBuildName 

func (_options *CreateBuildRunOptions) SetBuildName(buildName string) *CreateBuildRunOptions

SetBuildName : Allow user to set BuildName

func (*CreateBuildRunOptions) SetHeaders 

func (options *CreateBuildRunOptions) SetHeaders(param map[string]string) *CreateBuildRunOptions

SetHeaders : Allow user to set Headers

func (*CreateBuildRunOptions) SetName 

func (_options *CreateBuildRunOptions) SetName(name string) *CreateBuildRunOptions

SetName : Allow user to set Name

func (*CreateBuildRunOptions) SetOutputImage 

func (_options *CreateBuildRunOptions) SetOutputImage(outputImage string) *CreateBuildRunOptions

SetOutputImage : Allow user to set OutputImage

func (*CreateBuildRunOptions) SetOutputSecret 

func (_options *CreateBuildRunOptions) SetOutputSecret(outputSecret string) *CreateBuildRunOptions

SetOutputSecret : Allow user to set OutputSecret

func (*CreateBuildRunOptions) SetProjectID 

func (_options *CreateBuildRunOptions) SetProjectID(projectID string) *CreateBuildRunOptions

SetProjectID : Allow user to set ProjectID

func (*CreateBuildRunOptions) SetServiceAccount 

func (_options *CreateBuildRunOptions) SetServiceAccount(serviceAccount string) *CreateBuildRunOptions

SetServiceAccount : Allow user to set ServiceAccount

func (*CreateBuildRunOptions) SetSourceContextDir 

func (_options *CreateBuildRunOptions) SetSourceContextDir(sourceContextDir string) *CreateBuildRunOptions

SetSourceContextDir : Allow user to set SourceContextDir

func (*CreateBuildRunOptions) SetSourceRevision 

func (_options *CreateBuildRunOptions) SetSourceRevision(sourceRevision string) *CreateBuildRunOptions

SetSourceRevision : Allow user to set SourceRevision

func (*CreateBuildRunOptions) SetSourceSecret 

func (_options *CreateBuildRunOptions) SetSourceSecret(sourceSecret string) *CreateBuildRunOptions

SetSourceSecret : Allow user to set SourceSecret

func (*CreateBuildRunOptions) SetSourceType 

func (_options *CreateBuildRunOptions) SetSourceType(sourceType string) *CreateBuildRunOptions

SetSourceType : Allow user to set SourceType

func (*CreateBuildRunOptions) SetSourceURL 

func (_options *CreateBuildRunOptions) SetSourceURL(sourceURL string) *CreateBuildRunOptions

SetSourceURL : Allow user to set SourceURL

func (*CreateBuildRunOptions) SetStrategySize 

func (_options *CreateBuildRunOptions) SetStrategySize(strategySize string) *CreateBuildRunOptions

SetStrategySize : Allow user to set StrategySize

func (*CreateBuildRunOptions) SetStrategySpecFile 

func (_options *CreateBuildRunOptions) SetStrategySpecFile(strategySpecFile string) *CreateBuildRunOptions

SetStrategySpecFile : Allow user to set StrategySpecFile

func (*CreateBuildRunOptions) SetStrategyType 

func (_options *CreateBuildRunOptions) SetStrategyType(strategyType string) *CreateBuildRunOptions

SetStrategyType : Allow user to set StrategyType

func (*CreateBuildRunOptions) SetTimeout 

func (_options *CreateBuildRunOptions) SetTimeout(timeout int64) *CreateBuildRunOptions

SetTimeout : Allow user to set Timeout

type CreateConfigMapOptions 

type CreateConfigMapOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of the configmap. Use a name that is unique within the project.
	Name *string `json:"name" validate:"required"`

	// The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist
	// of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE`
	// field can consists of any character and must not be exceed a max length of 1048576 characters.
	Data map[string]string `json:"data,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateConfigMapOptions : The CreateConfigMap options.

func (*CreateConfigMapOptions) SetData 

func (_options *CreateConfigMapOptions) SetData(data map[string]string) *CreateConfigMapOptions

SetData : Allow user to set Data

func (*CreateConfigMapOptions) SetHeaders 

func (options *CreateConfigMapOptions) SetHeaders(param map[string]string) *CreateConfigMapOptions

SetHeaders : Allow user to set Headers

func (*CreateConfigMapOptions) SetName 

func (_options *CreateConfigMapOptions) SetName(name string) *CreateConfigMapOptions

SetName : Allow user to set Name

func (*CreateConfigMapOptions) SetProjectID 

func (_options *CreateConfigMapOptions) SetProjectID(projectID string) *CreateConfigMapOptions

SetProjectID : Allow user to set ProjectID

type CreateDomainMappingOptions 

type CreateDomainMappingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// A reference to another component.
	Component *ComponentRef `json:"component" validate:"required"`

	// The name of the domain mapping.
	Name *string `json:"name" validate:"required"`

	// The name of the TLS secret that holds the certificate and private key of this domain mapping.
	TlsSecret *string `json:"tls_secret" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateDomainMappingOptions : The CreateDomainMapping options.

func (*CreateDomainMappingOptions) SetComponent 

func (_options *CreateDomainMappingOptions) SetComponent(component *ComponentRef) *CreateDomainMappingOptions

SetComponent : Allow user to set Component

func (*CreateDomainMappingOptions) SetHeaders 

func (options *CreateDomainMappingOptions) SetHeaders(param map[string]string) *CreateDomainMappingOptions

SetHeaders : Allow user to set Headers

func (*CreateDomainMappingOptions) SetName 

func (_options *CreateDomainMappingOptions) SetName(name string) *CreateDomainMappingOptions

SetName : Allow user to set Name

func (*CreateDomainMappingOptions) SetProjectID 

func (_options *CreateDomainMappingOptions) SetProjectID(projectID string) *CreateDomainMappingOptions

SetProjectID : Allow user to set ProjectID

func (*CreateDomainMappingOptions) SetTlsSecret 

func (_options *CreateDomainMappingOptions) SetTlsSecret(tlsSecret string) *CreateDomainMappingOptions

SetTlsSecret : Allow user to set TlsSecret

type CreateJobOptions 

type CreateJobOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference" validate:"required"`

	// The name of the job. Use a name that is unique within the project.
	Name *string `json:"name" validate:"required"`

	// The name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the job / job runs will be created but submitted job runs will fail, until this property is
	// provided, too. This property must not be set on a job run, which references a job template.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Set arguments for the job that are passed to start job run containers. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments,omitempty"`

	// The user ID (UID) to run the job (e.g., 1001).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Set commands for the job that are passed to start job run containers. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands,omitempty"`

	// Optional references to config maps, secrets or literal values.
	RunEnvVariables []EnvVarPrototype `json:"run_env_variables,omitempty"`

	// The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and
	// `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted
	// indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.
	RunMode *string `json:"run_mode,omitempty"`

	// The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`,
	// `reader`, and `writer`. This property must not be set on a job run, which references a job template.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets.
	RunVolumeMounts []VolumeMountPrototype `json:"run_volume_mounts,omitempty"`

	// Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges
	// like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of
	// unique array indices specified here determines the number of job instances to run.
	ScaleArraySpec *string `json:"scale_array_spec,omitempty"`

	// Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is
	// `task`.
	ScaleMaxExecutionTime *int64 `json:"scale_max_execution_time,omitempty"`

	// Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// The number of times to rerun an instance of the job before the job is marked as failed. This property can only be
	// specified if `run_mode` is `task`.
	ScaleRetryLimit *int64 `json:"scale_retry_limit,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateJobOptions : The CreateJob options.

func (*CreateJobOptions) SetHeaders 

func (options *CreateJobOptions) SetHeaders(param map[string]string) *CreateJobOptions

SetHeaders : Allow user to set Headers

func (*CreateJobOptions) SetImageReference 

func (_options *CreateJobOptions) SetImageReference(imageReference string) *CreateJobOptions

SetImageReference : Allow user to set ImageReference

func (*CreateJobOptions) SetImageSecret 

func (_options *CreateJobOptions) SetImageSecret(imageSecret string) *CreateJobOptions

SetImageSecret : Allow user to set ImageSecret

func (*CreateJobOptions) SetName 

func (_options *CreateJobOptions) SetName(name string) *CreateJobOptions

SetName : Allow user to set Name

func (*CreateJobOptions) SetProjectID 

func (_options *CreateJobOptions) SetProjectID(projectID string) *CreateJobOptions

SetProjectID : Allow user to set ProjectID

func (*CreateJobOptions) SetRunArguments 

func (_options *CreateJobOptions) SetRunArguments(runArguments []string) *CreateJobOptions

SetRunArguments : Allow user to set RunArguments

func (*CreateJobOptions) SetRunAsUser 

func (_options *CreateJobOptions) SetRunAsUser(runAsUser int64) *CreateJobOptions

SetRunAsUser : Allow user to set RunAsUser

func (*CreateJobOptions) SetRunCommands 

func (_options *CreateJobOptions) SetRunCommands(runCommands []string) *CreateJobOptions

SetRunCommands : Allow user to set RunCommands

func (*CreateJobOptions) SetRunEnvVariables 

func (_options *CreateJobOptions) SetRunEnvVariables(runEnvVariables []EnvVarPrototype) *CreateJobOptions

SetRunEnvVariables : Allow user to set RunEnvVariables

func (*CreateJobOptions) SetRunMode 

func (_options *CreateJobOptions) SetRunMode(runMode string) *CreateJobOptions

SetRunMode : Allow user to set RunMode

func (*CreateJobOptions) SetRunServiceAccount 

func (_options *CreateJobOptions) SetRunServiceAccount(runServiceAccount string) *CreateJobOptions

SetRunServiceAccount : Allow user to set RunServiceAccount

func (*CreateJobOptions) SetRunVolumeMounts 

func (_options *CreateJobOptions) SetRunVolumeMounts(runVolumeMounts []VolumeMountPrototype) *CreateJobOptions

SetRunVolumeMounts : Allow user to set RunVolumeMounts

func (*CreateJobOptions) SetScaleArraySpec 

func (_options *CreateJobOptions) SetScaleArraySpec(scaleArraySpec string) *CreateJobOptions

SetScaleArraySpec : Allow user to set ScaleArraySpec

func (*CreateJobOptions) SetScaleCpuLimit 

func (_options *CreateJobOptions) SetScaleCpuLimit(scaleCpuLimit string) *CreateJobOptions

SetScaleCpuLimit : Allow user to set ScaleCpuLimit

func (*CreateJobOptions) SetScaleEphemeralStorageLimit 

func (_options *CreateJobOptions) SetScaleEphemeralStorageLimit(scaleEphemeralStorageLimit string) *CreateJobOptions

SetScaleEphemeralStorageLimit : Allow user to set ScaleEphemeralStorageLimit

func (*CreateJobOptions) SetScaleMaxExecutionTime 

func (_options *CreateJobOptions) SetScaleMaxExecutionTime(scaleMaxExecutionTime int64) *CreateJobOptions

SetScaleMaxExecutionTime : Allow user to set ScaleMaxExecutionTime

func (*CreateJobOptions) SetScaleMemoryLimit 

func (_options *CreateJobOptions) SetScaleMemoryLimit(scaleMemoryLimit string) *CreateJobOptions

SetScaleMemoryLimit : Allow user to set ScaleMemoryLimit

func (*CreateJobOptions) SetScaleRetryLimit 

func (_options *CreateJobOptions) SetScaleRetryLimit(scaleRetryLimit int64) *CreateJobOptions

SetScaleRetryLimit : Allow user to set ScaleRetryLimit

type CreateJobRunOptions 

type CreateJobRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference,omitempty"`

	// The name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the job / job runs will be created but submitted job runs will fail, until this property is
	// provided, too. This property must not be set on a job run, which references a job template.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Optional name of the job on which this job run is based on. If specified, the job run will inherit the configuration
	// of the referenced job.
	JobName *string `json:"job_name,omitempty"`

	// The name of the job. Use a name that is unique within the project.
	Name *string `json:"name,omitempty"`

	// Set arguments for the job that are passed to start job run containers. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments,omitempty"`

	// The user ID (UID) to run the job (e.g., 1001).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Set commands for the job that are passed to start job run containers. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands,omitempty"`

	// Optional references to config maps, secrets or literal values.
	RunEnvVariables []EnvVarPrototype `json:"run_env_variables,omitempty"`

	// The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and
	// `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted
	// indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.
	RunMode *string `json:"run_mode,omitempty"`

	// The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`,
	// `reader`, and `writer`. This property must not be set on a job run, which references a job template.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets.
	RunVolumeMounts []VolumeMountPrototype `json:"run_volume_mounts,omitempty"`

	// Optional value to override the JOB_ARRAY_SIZE environment variable for a job run.
	ScaleArraySizeVariableOverride *int64 `json:"scale_array_size_variable_override,omitempty"`

	// Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges
	// like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of
	// unique array indices specified here determines the number of job instances to run.
	ScaleArraySpec *string `json:"scale_array_spec,omitempty"`

	// Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is
	// `task`.
	ScaleMaxExecutionTime *int64 `json:"scale_max_execution_time,omitempty"`

	// Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// The number of times to rerun an instance of the job before the job is marked as failed. This property can only be
	// specified if `run_mode` is `task`.
	ScaleRetryLimit *int64 `json:"scale_retry_limit,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateJobRunOptions : The CreateJobRun options.

func (*CreateJobRunOptions) SetHeaders 

func (options *CreateJobRunOptions) SetHeaders(param map[string]string) *CreateJobRunOptions

SetHeaders : Allow user to set Headers

func (*CreateJobRunOptions) SetImageReference 

func (_options *CreateJobRunOptions) SetImageReference(imageReference string) *CreateJobRunOptions

SetImageReference : Allow user to set ImageReference

func (*CreateJobRunOptions) SetImageSecret 

func (_options *CreateJobRunOptions) SetImageSecret(imageSecret string) *CreateJobRunOptions

SetImageSecret : Allow user to set ImageSecret

func (*CreateJobRunOptions) SetJobName 

func (_options *CreateJobRunOptions) SetJobName(jobName string) *CreateJobRunOptions

SetJobName : Allow user to set JobName

func (*CreateJobRunOptions) SetName 

func (_options *CreateJobRunOptions) SetName(name string) *CreateJobRunOptions

SetName : Allow user to set Name

func (*CreateJobRunOptions) SetProjectID 

func (_options *CreateJobRunOptions) SetProjectID(projectID string) *CreateJobRunOptions

SetProjectID : Allow user to set ProjectID

func (*CreateJobRunOptions) SetRunArguments 

func (_options *CreateJobRunOptions) SetRunArguments(runArguments []string) *CreateJobRunOptions

SetRunArguments : Allow user to set RunArguments

func (*CreateJobRunOptions) SetRunAsUser 

func (_options *CreateJobRunOptions) SetRunAsUser(runAsUser int64) *CreateJobRunOptions

SetRunAsUser : Allow user to set RunAsUser

func (*CreateJobRunOptions) SetRunCommands 

func (_options *CreateJobRunOptions) SetRunCommands(runCommands []string) *CreateJobRunOptions

SetRunCommands : Allow user to set RunCommands

func (*CreateJobRunOptions) SetRunEnvVariables 

func (_options *CreateJobRunOptions) SetRunEnvVariables(runEnvVariables []EnvVarPrototype) *CreateJobRunOptions

SetRunEnvVariables : Allow user to set RunEnvVariables

func (*CreateJobRunOptions) SetRunMode 

func (_options *CreateJobRunOptions) SetRunMode(runMode string) *CreateJobRunOptions

SetRunMode : Allow user to set RunMode

func (*CreateJobRunOptions) SetRunServiceAccount 

func (_options *CreateJobRunOptions) SetRunServiceAccount(runServiceAccount string) *CreateJobRunOptions

SetRunServiceAccount : Allow user to set RunServiceAccount

func (*CreateJobRunOptions) SetRunVolumeMounts 

func (_options *CreateJobRunOptions) SetRunVolumeMounts(runVolumeMounts []VolumeMountPrototype) *CreateJobRunOptions

SetRunVolumeMounts : Allow user to set RunVolumeMounts

func (*CreateJobRunOptions) SetScaleArraySizeVariableOverride 

func (_options *CreateJobRunOptions) SetScaleArraySizeVariableOverride(scaleArraySizeVariableOverride int64) *CreateJobRunOptions

SetScaleArraySizeVariableOverride : Allow user to set ScaleArraySizeVariableOverride

func (*CreateJobRunOptions) SetScaleArraySpec 

func (_options *CreateJobRunOptions) SetScaleArraySpec(scaleArraySpec string) *CreateJobRunOptions

SetScaleArraySpec : Allow user to set ScaleArraySpec

func (*CreateJobRunOptions) SetScaleCpuLimit 

func (_options *CreateJobRunOptions) SetScaleCpuLimit(scaleCpuLimit string) *CreateJobRunOptions

SetScaleCpuLimit : Allow user to set ScaleCpuLimit

func (*CreateJobRunOptions) SetScaleEphemeralStorageLimit 

func (_options *CreateJobRunOptions) SetScaleEphemeralStorageLimit(scaleEphemeralStorageLimit string) *CreateJobRunOptions

SetScaleEphemeralStorageLimit : Allow user to set ScaleEphemeralStorageLimit

func (*CreateJobRunOptions) SetScaleMaxExecutionTime 

func (_options *CreateJobRunOptions) SetScaleMaxExecutionTime(scaleMaxExecutionTime int64) *CreateJobRunOptions

SetScaleMaxExecutionTime : Allow user to set ScaleMaxExecutionTime

func (*CreateJobRunOptions) SetScaleMemoryLimit 

func (_options *CreateJobRunOptions) SetScaleMemoryLimit(scaleMemoryLimit string) *CreateJobRunOptions

SetScaleMemoryLimit : Allow user to set ScaleMemoryLimit

func (*CreateJobRunOptions) SetScaleRetryLimit 

func (_options *CreateJobRunOptions) SetScaleRetryLimit(scaleRetryLimit int64) *CreateJobRunOptions

SetScaleRetryLimit : Allow user to set ScaleRetryLimit

type CreateProjectOptions 

type CreateProjectOptions struct {
	// The name of the project.
	Name *string `json:"name" validate:"required"`

	// Optional ID of the resource group for your project deployment. If this field is not defined, the default resource
	// group of the account will be used.
	ResourceGroupID *string `json:"resource_group_id,omitempty"`

	// Optional list of labels to assign to your project. Tags are not part of the project resource that is returned by the
	// server, but can be obtained and managed through the Global Tagging API in IBM Cloud. Find more information on
	// [Global Tagging API docs](https://cloud.ibm.com/apidocs/tagging).
	Tags []string `json:"tags,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateProjectOptions : The CreateProject options.

func (*CreateProjectOptions) SetHeaders 

func (options *CreateProjectOptions) SetHeaders(param map[string]string) *CreateProjectOptions

SetHeaders : Allow user to set Headers

func (*CreateProjectOptions) SetName 

func (_options *CreateProjectOptions) SetName(name string) *CreateProjectOptions

SetName : Allow user to set Name

func (*CreateProjectOptions) SetResourceGroupID 

func (_options *CreateProjectOptions) SetResourceGroupID(resourceGroupID string) *CreateProjectOptions

SetResourceGroupID : Allow user to set ResourceGroupID

func (*CreateProjectOptions) SetTags 

func (_options *CreateProjectOptions) SetTags(tags []string) *CreateProjectOptions

SetTags : Allow user to set Tags

type CreateSecretOptions 

type CreateSecretOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Specify the format of the secret. The format of the secret will determine how the secret is used.
	Format *string `json:"format" validate:"required"`

	// The name of the secret.
	Name *string `json:"name" validate:"required"`

	// Data container that allows to specify config parameters and their values as a key-value map. Each key field must
	// consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value
	// field can consists of any character and must not exceed a max length of 1048576 characters.
	Data SecretDataIntf `json:"data,omitempty"`

	// Properties for Service Access Secret Prototypes.
	ServiceAccess *ServiceAccessSecretPrototypeProps `json:"service_access,omitempty"`

	// Properties for the IBM Cloud Operator Secret Prototype.
	ServiceOperator *OperatorSecretPrototypeProps `json:"service_operator,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateSecretOptions : The CreateSecret options.

func (*CreateSecretOptions) SetData 

func (_options *CreateSecretOptions) SetData(data SecretDataIntf) *CreateSecretOptions

SetData : Allow user to set Data

func (*CreateSecretOptions) SetFormat 

func (_options *CreateSecretOptions) SetFormat(format string) *CreateSecretOptions

SetFormat : Allow user to set Format

func (*CreateSecretOptions) SetHeaders 

func (options *CreateSecretOptions) SetHeaders(param map[string]string) *CreateSecretOptions

SetHeaders : Allow user to set Headers

func (*CreateSecretOptions) SetName 

func (_options *CreateSecretOptions) SetName(name string) *CreateSecretOptions

SetName : Allow user to set Name

func (*CreateSecretOptions) SetProjectID 

func (_options *CreateSecretOptions) SetProjectID(projectID string) *CreateSecretOptions

SetProjectID : Allow user to set ProjectID

func (*CreateSecretOptions) SetServiceAccess 

func (_options *CreateSecretOptions) SetServiceAccess(serviceAccess *ServiceAccessSecretPrototypeProps) *CreateSecretOptions

SetServiceAccess : Allow user to set ServiceAccess

func (*CreateSecretOptions) SetServiceOperator 

func (_options *CreateSecretOptions) SetServiceOperator(serviceOperator *OperatorSecretPrototypeProps) *CreateSecretOptions

SetServiceOperator : Allow user to set ServiceOperator

type DeleteAppOptions 

type DeleteAppOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAppOptions : The DeleteApp options.

func (*DeleteAppOptions) SetHeaders 

func (options *DeleteAppOptions) SetHeaders(param map[string]string) *DeleteAppOptions

SetHeaders : Allow user to set Headers

func (*DeleteAppOptions) SetName 

func (_options *DeleteAppOptions) SetName(name string) *DeleteAppOptions

SetName : Allow user to set Name

func (*DeleteAppOptions) SetProjectID 

func (_options *DeleteAppOptions) SetProjectID(projectID string) *DeleteAppOptions

SetProjectID : Allow user to set ProjectID

type DeleteAppRevisionOptions 

type DeleteAppRevisionOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	AppName *string `json:"app_name" validate:"required,ne="`

	// The name of your application revision.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteAppRevisionOptions : The DeleteAppRevision options.

func (*DeleteAppRevisionOptions) SetAppName 

func (_options *DeleteAppRevisionOptions) SetAppName(appName string) *DeleteAppRevisionOptions

SetAppName : Allow user to set AppName

func (*DeleteAppRevisionOptions) SetHeaders 

func (options *DeleteAppRevisionOptions) SetHeaders(param map[string]string) *DeleteAppRevisionOptions

SetHeaders : Allow user to set Headers

func (*DeleteAppRevisionOptions) SetName 

func (_options *DeleteAppRevisionOptions) SetName(name string) *DeleteAppRevisionOptions

SetName : Allow user to set Name

func (*DeleteAppRevisionOptions) SetProjectID 

func (_options *DeleteAppRevisionOptions) SetProjectID(projectID string) *DeleteAppRevisionOptions

SetProjectID : Allow user to set ProjectID

type DeleteBindingOptions 

type DeleteBindingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The id of your binding.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteBindingOptions : The DeleteBinding options.

func (*DeleteBindingOptions) SetHeaders 

func (options *DeleteBindingOptions) SetHeaders(param map[string]string) *DeleteBindingOptions

SetHeaders : Allow user to set Headers

func (*DeleteBindingOptions) SetID 

func (_options *DeleteBindingOptions) SetID(id string) *DeleteBindingOptions

SetID : Allow user to set ID

func (*DeleteBindingOptions) SetProjectID 

func (_options *DeleteBindingOptions) SetProjectID(projectID string) *DeleteBindingOptions

SetProjectID : Allow user to set ProjectID

type DeleteBuildOptions 

type DeleteBuildOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your build.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteBuildOptions : The DeleteBuild options.

func (*DeleteBuildOptions) SetHeaders 

func (options *DeleteBuildOptions) SetHeaders(param map[string]string) *DeleteBuildOptions

SetHeaders : Allow user to set Headers

func (*DeleteBuildOptions) SetName 

func (_options *DeleteBuildOptions) SetName(name string) *DeleteBuildOptions

SetName : Allow user to set Name

func (*DeleteBuildOptions) SetProjectID 

func (_options *DeleteBuildOptions) SetProjectID(projectID string) *DeleteBuildOptions

SetProjectID : Allow user to set ProjectID

type DeleteBuildRunOptions 

type DeleteBuildRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your build run.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteBuildRunOptions : The DeleteBuildRun options.

func (*DeleteBuildRunOptions) SetHeaders 

func (options *DeleteBuildRunOptions) SetHeaders(param map[string]string) *DeleteBuildRunOptions

SetHeaders : Allow user to set Headers

func (*DeleteBuildRunOptions) SetName 

func (_options *DeleteBuildRunOptions) SetName(name string) *DeleteBuildRunOptions

SetName : Allow user to set Name

func (*DeleteBuildRunOptions) SetProjectID 

func (_options *DeleteBuildRunOptions) SetProjectID(projectID string) *DeleteBuildRunOptions

SetProjectID : Allow user to set ProjectID

type DeleteConfigMapOptions 

type DeleteConfigMapOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your configmap.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteConfigMapOptions : The DeleteConfigMap options.

func (*DeleteConfigMapOptions) SetHeaders 

func (options *DeleteConfigMapOptions) SetHeaders(param map[string]string) *DeleteConfigMapOptions

SetHeaders : Allow user to set Headers

func (*DeleteConfigMapOptions) SetName 

func (_options *DeleteConfigMapOptions) SetName(name string) *DeleteConfigMapOptions

SetName : Allow user to set Name

func (*DeleteConfigMapOptions) SetProjectID 

func (_options *DeleteConfigMapOptions) SetProjectID(projectID string) *DeleteConfigMapOptions

SetProjectID : Allow user to set ProjectID

type DeleteDomainMappingOptions 

type DeleteDomainMappingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your domain mapping.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteDomainMappingOptions : The DeleteDomainMapping options.

func (*DeleteDomainMappingOptions) SetHeaders 

func (options *DeleteDomainMappingOptions) SetHeaders(param map[string]string) *DeleteDomainMappingOptions

SetHeaders : Allow user to set Headers

func (*DeleteDomainMappingOptions) SetName 

func (_options *DeleteDomainMappingOptions) SetName(name string) *DeleteDomainMappingOptions

SetName : Allow user to set Name

func (*DeleteDomainMappingOptions) SetProjectID 

func (_options *DeleteDomainMappingOptions) SetProjectID(projectID string) *DeleteDomainMappingOptions

SetProjectID : Allow user to set ProjectID

type DeleteJobOptions 

type DeleteJobOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your job.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteJobOptions : The DeleteJob options.

func (*DeleteJobOptions) SetHeaders 

func (options *DeleteJobOptions) SetHeaders(param map[string]string) *DeleteJobOptions

SetHeaders : Allow user to set Headers

func (*DeleteJobOptions) SetName 

func (_options *DeleteJobOptions) SetName(name string) *DeleteJobOptions

SetName : Allow user to set Name

func (*DeleteJobOptions) SetProjectID 

func (_options *DeleteJobOptions) SetProjectID(projectID string) *DeleteJobOptions

SetProjectID : Allow user to set ProjectID

type DeleteJobRunOptions 

type DeleteJobRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your job run.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteJobRunOptions : The DeleteJobRun options.

func (*DeleteJobRunOptions) SetHeaders 

func (options *DeleteJobRunOptions) SetHeaders(param map[string]string) *DeleteJobRunOptions

SetHeaders : Allow user to set Headers

func (*DeleteJobRunOptions) SetName 

func (_options *DeleteJobRunOptions) SetName(name string) *DeleteJobRunOptions

SetName : Allow user to set Name

func (*DeleteJobRunOptions) SetProjectID 

func (_options *DeleteJobRunOptions) SetProjectID(projectID string) *DeleteJobRunOptions

SetProjectID : Allow user to set ProjectID

type DeleteProjectOptions 

type DeleteProjectOptions struct {
	// The ID of the project.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteProjectOptions : The DeleteProject options.

func (*DeleteProjectOptions) SetHeaders 

func (options *DeleteProjectOptions) SetHeaders(param map[string]string) *DeleteProjectOptions

SetHeaders : Allow user to set Headers

func (*DeleteProjectOptions) SetID 

func (_options *DeleteProjectOptions) SetID(id string) *DeleteProjectOptions

SetID : Allow user to set ID

type DeleteSecretOptions 

type DeleteSecretOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your secret.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteSecretOptions : The DeleteSecret options.

func (*DeleteSecretOptions) SetHeaders 

func (options *DeleteSecretOptions) SetHeaders(param map[string]string) *DeleteSecretOptions

SetHeaders : Allow user to set Headers

func (*DeleteSecretOptions) SetName 

func (_options *DeleteSecretOptions) SetName(name string) *DeleteSecretOptions

SetName : Allow user to set Name

func (*DeleteSecretOptions) SetProjectID 

func (_options *DeleteSecretOptions) SetProjectID(projectID string) *DeleteSecretOptions

SetProjectID : Allow user to set ProjectID

type DomainMapping 

type DomainMapping struct {
	// Exposes the value of the CNAME record that needs to be configured in the DNS settings of the domain, to route
	// traffic properly to the target Code Engine region.
	CnameTarget *string `json:"cname_target,omitempty"`

	// A reference to another component.
	Component *ComponentRef `json:"component" validate:"required"`

	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// The version of the domain mapping instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// When you provision a new domain mapping, a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the domain mapping.
	Name *string `json:"name" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the CE Resource.
	ResourceType *string `json:"resource_type,omitempty"`

	// The current status of the domain mapping.
	Status *string `json:"status,omitempty"`

	// The detailed status of the domain mapping.
	StatusDetails *DomainMappingStatus `json:"status_details,omitempty"`

	// The name of the TLS secret that holds the certificate and private key of this domain mapping.
	TlsSecret *string `json:"tls_secret" validate:"required"`

	// Exposes whether the domain mapping is managed by the user or by Code Engine.
	UserManaged *bool `json:"user_managed,omitempty"`

	// Exposes whether the domain mapping is reachable through the public internet, or private IBM network, or only through
	// other components within the same Code Engine project.
	Visibility *string `json:"visibility,omitempty"`
}

DomainMapping : Response model for domain mapping definitions.

type DomainMappingList 

type DomainMappingList struct {
	// List of all domain mappings.
	DomainMappings []DomainMapping `json:"domain_mappings" validate:"required"`

	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

DomainMappingList : Contains a list of domain mappings and pagination information.

func (*DomainMappingList) GetNextStart 

func (resp *DomainMappingList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type DomainMappingPatch 

type DomainMappingPatch struct {
	// A reference to another component.
	Component *ComponentRef `json:"component,omitempty"`

	// The name of the TLS secret that holds the certificate and private key of this domain mapping.
	TlsSecret *string `json:"tls_secret,omitempty"`
}

DomainMappingPatch : Patch a domain mappings object.

func (*DomainMappingPatch) AsPatch 

func (domainMappingPatch *DomainMappingPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the DomainMappingPatch

type DomainMappingStatus 

type DomainMappingStatus struct {
	// Optional information to provide more context in case of a 'failed' or 'warning' status.
	Reason *string `json:"reason,omitempty"`
}

DomainMappingStatus : The detailed status of the domain mapping.

type DomainMappingsPager 

type DomainMappingsPager struct {
	// contains filtered or unexported fields
}

DomainMappingsPager can be used to simplify the use of the "ListDomainMappings" method.

func (*DomainMappingsPager) GetAll 

func (pager *DomainMappingsPager) GetAll() (allItems []DomainMapping, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*DomainMappingsPager) GetAllWithContext 

func (pager *DomainMappingsPager) GetAllWithContext(ctx context.Context) (allItems []DomainMapping, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*DomainMappingsPager) GetNext 

func (pager *DomainMappingsPager) GetNext() (page []DomainMapping, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*DomainMappingsPager) GetNextWithContext 

func (pager *DomainMappingsPager) GetNextWithContext(ctx context.Context) (page []DomainMapping, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*DomainMappingsPager) HasNext 

func (pager *DomainMappingsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type EnvVar 

type EnvVar struct {
	// The key to reference as environment variable.
	Key *string `json:"key,omitempty"`

	// The name of the environment variable.
	Name *string `json:"name,omitempty"`

	// A prefix that can be added to all keys of a full secret or config map reference.
	Prefix *string `json:"prefix,omitempty"`

	// The name of the secret or config map.
	Reference *string `json:"reference,omitempty"`

	// Specify the type of the environment variable.
	Type *string `json:"type" validate:"required"`

	// The literal value of the environment variable.
	Value *string `json:"value,omitempty"`
}

EnvVar : Response model for environment variables.

type EnvVarPrototype 

type EnvVarPrototype struct {
	// The key to reference as environment variable.
	Key *string `json:"key,omitempty"`

	// The name of the environment variable.
	Name *string `json:"name,omitempty"`

	// A prefix that can be added to all keys of a full secret or config map reference.
	Prefix *string `json:"prefix,omitempty"`

	// The name of the secret or config map.
	Reference *string `json:"reference,omitempty"`

	// Specify the type of the environment variable.
	Type *string `json:"type,omitempty"`

	// The literal value of the environment variable.
	Value *string `json:"value,omitempty"`
}

EnvVarPrototype : Prototype model for environment variables.

type GetAppOptions 

type GetAppOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAppOptions : The GetApp options.

func (*GetAppOptions) SetHeaders 

func (options *GetAppOptions) SetHeaders(param map[string]string) *GetAppOptions

SetHeaders : Allow user to set Headers

func (*GetAppOptions) SetName 

func (_options *GetAppOptions) SetName(name string) *GetAppOptions

SetName : Allow user to set Name

func (*GetAppOptions) SetProjectID 

func (_options *GetAppOptions) SetProjectID(projectID string) *GetAppOptions

SetProjectID : Allow user to set ProjectID

type GetAppRevisionOptions 

type GetAppRevisionOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	AppName *string `json:"app_name" validate:"required,ne="`

	// The name of your application revision.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetAppRevisionOptions : The GetAppRevision options.

func (*GetAppRevisionOptions) SetAppName 

func (_options *GetAppRevisionOptions) SetAppName(appName string) *GetAppRevisionOptions

SetAppName : Allow user to set AppName

func (*GetAppRevisionOptions) SetHeaders 

func (options *GetAppRevisionOptions) SetHeaders(param map[string]string) *GetAppRevisionOptions

SetHeaders : Allow user to set Headers

func (*GetAppRevisionOptions) SetName 

func (_options *GetAppRevisionOptions) SetName(name string) *GetAppRevisionOptions

SetName : Allow user to set Name

func (*GetAppRevisionOptions) SetProjectID 

func (_options *GetAppRevisionOptions) SetProjectID(projectID string) *GetAppRevisionOptions

SetProjectID : Allow user to set ProjectID

type GetBindingOptions 

type GetBindingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The id of your binding.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBindingOptions : The GetBinding options.

func (*GetBindingOptions) SetHeaders 

func (options *GetBindingOptions) SetHeaders(param map[string]string) *GetBindingOptions

SetHeaders : Allow user to set Headers

func (*GetBindingOptions) SetID 

func (_options *GetBindingOptions) SetID(id string) *GetBindingOptions

SetID : Allow user to set ID

func (*GetBindingOptions) SetProjectID 

func (_options *GetBindingOptions) SetProjectID(projectID string) *GetBindingOptions

SetProjectID : Allow user to set ProjectID

type GetBuildOptions 

type GetBuildOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your build.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBuildOptions : The GetBuild options.

func (*GetBuildOptions) SetHeaders 

func (options *GetBuildOptions) SetHeaders(param map[string]string) *GetBuildOptions

SetHeaders : Allow user to set Headers

func (*GetBuildOptions) SetName 

func (_options *GetBuildOptions) SetName(name string) *GetBuildOptions

SetName : Allow user to set Name

func (*GetBuildOptions) SetProjectID 

func (_options *GetBuildOptions) SetProjectID(projectID string) *GetBuildOptions

SetProjectID : Allow user to set ProjectID

type GetBuildRunOptions 

type GetBuildRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your build run.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetBuildRunOptions : The GetBuildRun options.

func (*GetBuildRunOptions) SetHeaders 

func (options *GetBuildRunOptions) SetHeaders(param map[string]string) *GetBuildRunOptions

SetHeaders : Allow user to set Headers

func (*GetBuildRunOptions) SetName 

func (_options *GetBuildRunOptions) SetName(name string) *GetBuildRunOptions

SetName : Allow user to set Name

func (*GetBuildRunOptions) SetProjectID 

func (_options *GetBuildRunOptions) SetProjectID(projectID string) *GetBuildRunOptions

SetProjectID : Allow user to set ProjectID

type GetConfigMapOptions 

type GetConfigMapOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your configmap.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetConfigMapOptions : The GetConfigMap options.

func (*GetConfigMapOptions) SetHeaders 

func (options *GetConfigMapOptions) SetHeaders(param map[string]string) *GetConfigMapOptions

SetHeaders : Allow user to set Headers

func (*GetConfigMapOptions) SetName 

func (_options *GetConfigMapOptions) SetName(name string) *GetConfigMapOptions

SetName : Allow user to set Name

func (*GetConfigMapOptions) SetProjectID 

func (_options *GetConfigMapOptions) SetProjectID(projectID string) *GetConfigMapOptions

SetProjectID : Allow user to set ProjectID

type GetDomainMappingOptions 

type GetDomainMappingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your domain mapping.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetDomainMappingOptions : The GetDomainMapping options.

func (*GetDomainMappingOptions) SetHeaders 

func (options *GetDomainMappingOptions) SetHeaders(param map[string]string) *GetDomainMappingOptions

SetHeaders : Allow user to set Headers

func (*GetDomainMappingOptions) SetName 

func (_options *GetDomainMappingOptions) SetName(name string) *GetDomainMappingOptions

SetName : Allow user to set Name

func (*GetDomainMappingOptions) SetProjectID 

func (_options *GetDomainMappingOptions) SetProjectID(projectID string) *GetDomainMappingOptions

SetProjectID : Allow user to set ProjectID

type GetJobOptions 

type GetJobOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your job.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetJobOptions : The GetJob options.

func (*GetJobOptions) SetHeaders 

func (options *GetJobOptions) SetHeaders(param map[string]string) *GetJobOptions

SetHeaders : Allow user to set Headers

func (*GetJobOptions) SetName 

func (_options *GetJobOptions) SetName(name string) *GetJobOptions

SetName : Allow user to set Name

func (*GetJobOptions) SetProjectID 

func (_options *GetJobOptions) SetProjectID(projectID string) *GetJobOptions

SetProjectID : Allow user to set ProjectID

type GetJobRunOptions 

type GetJobRunOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your job run.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetJobRunOptions : The GetJobRun options.

func (*GetJobRunOptions) SetHeaders 

func (options *GetJobRunOptions) SetHeaders(param map[string]string) *GetJobRunOptions

SetHeaders : Allow user to set Headers

func (*GetJobRunOptions) SetName 

func (_options *GetJobRunOptions) SetName(name string) *GetJobRunOptions

SetName : Allow user to set Name

func (*GetJobRunOptions) SetProjectID 

func (_options *GetJobRunOptions) SetProjectID(projectID string) *GetJobRunOptions

SetProjectID : Allow user to set ProjectID

type GetProjectEgressIpsOptions 

type GetProjectEgressIpsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetProjectEgressIpsOptions : The GetProjectEgressIps options.

func (*GetProjectEgressIpsOptions) SetHeaders 

func (options *GetProjectEgressIpsOptions) SetHeaders(param map[string]string) *GetProjectEgressIpsOptions

SetHeaders : Allow user to set Headers

func (*GetProjectEgressIpsOptions) SetProjectID 

func (_options *GetProjectEgressIpsOptions) SetProjectID(projectID string) *GetProjectEgressIpsOptions

SetProjectID : Allow user to set ProjectID

type GetProjectOptions 

type GetProjectOptions struct {
	// The ID of the project.
	ID *string `json:"id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetProjectOptions : The GetProject options.

func (*GetProjectOptions) SetHeaders 

func (options *GetProjectOptions) SetHeaders(param map[string]string) *GetProjectOptions

SetHeaders : Allow user to set Headers

func (*GetProjectOptions) SetID 

func (_options *GetProjectOptions) SetID(id string) *GetProjectOptions

SetID : Allow user to set ID

type GetProjectStatusDetailsOptions 

type GetProjectStatusDetailsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetProjectStatusDetailsOptions : The GetProjectStatusDetails options.

func (*GetProjectStatusDetailsOptions) SetHeaders 

func (options *GetProjectStatusDetailsOptions) SetHeaders(param map[string]string) *GetProjectStatusDetailsOptions

SetHeaders : Allow user to set Headers

func (*GetProjectStatusDetailsOptions) SetProjectID 

func (_options *GetProjectStatusDetailsOptions) SetProjectID(projectID string) *GetProjectStatusDetailsOptions

SetProjectID : Allow user to set ProjectID

type GetSecretOptions 

type GetSecretOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your secret.
	Name *string `json:"name" validate:"required,ne="`

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetSecretOptions : The GetSecret options.

func (*GetSecretOptions) SetHeaders 

func (options *GetSecretOptions) SetHeaders(param map[string]string) *GetSecretOptions

SetHeaders : Allow user to set Headers

func (*GetSecretOptions) SetName 

func (_options *GetSecretOptions) SetName(name string) *GetSecretOptions

SetName : Allow user to set Name

func (*GetSecretOptions) SetProjectID 

func (_options *GetSecretOptions) SetProjectID(projectID string) *GetSecretOptions

SetProjectID : Allow user to set ProjectID

type Job 

type Job struct {
	// Reference to a build that is associated with the job.
	Build *string `json:"build,omitempty"`

	// Reference to a buildrun that is associated with the job.
	BuildRun *string `json:"build_run,omitempty"`

	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// The version of the job instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// When you provision a new job,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference" validate:"required"`

	// The name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the job / job runs will be created but submitted job runs will fail, until this property is
	// provided, too. This property must not be set on a job run, which references a job template.
	ImageSecret *string `json:"image_secret,omitempty"`

	// The name of the job.
	Name *string `json:"name" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the job.
	ResourceType *string `json:"resource_type,omitempty"`

	// Set arguments for the job that are passed to start job run containers. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments" validate:"required"`

	// The user ID (UID) to run the job (e.g., 1001).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Set commands for the job that are passed to start job run containers. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands" validate:"required"`

	// References to config maps, secrets or literal values, which are exposed as environment variables in the job run.
	RunEnvVariables []EnvVar `json:"run_env_variables" validate:"required"`

	// The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and
	// `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted
	// indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.
	RunMode *string `json:"run_mode" validate:"required"`

	// The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`,
	// `reader`, and `writer`. This property must not be set on a job run, which references a job template.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets.
	RunVolumeMounts []VolumeMount `json:"run_volume_mounts" validate:"required"`

	// Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges
	// like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of
	// unique array indices specified here determines the number of job instances to run.
	ScaleArraySpec *string `json:"scale_array_spec" validate:"required"`

	// Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit" validate:"required"`

	// Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit" validate:"required"`

	// The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is
	// `task`.
	ScaleMaxExecutionTime *int64 `json:"scale_max_execution_time,omitempty"`

	// Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit" validate:"required"`

	// The number of times to rerun an instance of the job before the job is marked as failed. This property can only be
	// specified if `run_mode` is `task`.
	ScaleRetryLimit *int64 `json:"scale_retry_limit,omitempty"`
}

Job : Job is the response model for job resources.

type JobList 

type JobList struct {
	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// List of all jobs.
	Jobs []Job `json:"jobs" validate:"required"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

JobList : Contains a list of jobs and pagination information.

func (*JobList) GetNextStart 

func (resp *JobList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type JobPatch 

type JobPatch struct {
	// The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference,omitempty"`

	// The name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the job / job runs will be created but submitted job runs will fail, until this property is
	// provided, too. This property must not be set on a job run, which references a job template.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Set arguments for the job that are passed to start job run containers. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments,omitempty"`

	// The user ID (UID) to run the job (e.g., 1001).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Set commands for the job that are passed to start job run containers. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands,omitempty"`

	// Optional references to config maps, secrets or literal values.
	RunEnvVariables []EnvVarPrototype `json:"run_env_variables,omitempty"`

	// The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and
	// `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted
	// indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.
	RunMode *string `json:"run_mode,omitempty"`

	// The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`,
	// `reader`, and `writer`. This property must not be set on a job run, which references a job template.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets. In case this is provided, existing `run_volume_mounts` will be
	// overwritten.
	RunVolumeMounts []VolumeMountPrototype `json:"run_volume_mounts,omitempty"`

	// Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges
	// like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of
	// unique array indices specified here determines the number of job instances to run.
	ScaleArraySpec *string `json:"scale_array_spec,omitempty"`

	// Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is
	// `task`.
	ScaleMaxExecutionTime *int64 `json:"scale_max_execution_time,omitempty"`

	// Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// The number of times to rerun an instance of the job before the job is marked as failed. This property can only be
	// specified if `run_mode` is `task`.
	ScaleRetryLimit *int64 `json:"scale_retry_limit,omitempty"`
}

JobPatch : Request model for job update operations.

func (*JobPatch) AsPatch 

func (jobPatch *JobPatch) AsPatch() (_patch map[string]interface{}, err error)

AsPatch returns a generic map representation of the JobPatch

type JobRun 

type JobRun struct {
	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// When you provision a new job run,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the image that is used for this job. The format is `REGISTRY/NAMESPACE/REPOSITORY:TAG` where `REGISTRY`
	// and `TAG` are optional. If `REGISTRY` is not specified, the default is `docker.io`. If `TAG` is not specified, the
	// default is `latest`. If the image reference points to a registry that requires authentication, make sure to also
	// specify the property `image_secret`.
	ImageReference *string `json:"image_reference,omitempty"`

	// The name of the image registry access secret. The image registry access secret is used to authenticate with a
	// private registry when you download the container image. If the image reference points to a registry that requires
	// authentication, the job / job runs will be created but submitted job runs will fail, until this property is
	// provided, too. This property must not be set on a job run, which references a job template.
	ImageSecret *string `json:"image_secret,omitempty"`

	// Optional name of the job reference of this job run. If specified, the job run will inherit the configuration of the
	// referenced job.
	JobName *string `json:"job_name,omitempty"`

	// The name of the job run.
	Name *string `json:"name,omitempty"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the job run.
	ResourceType *string `json:"resource_type,omitempty"`

	// Set arguments for the job that are passed to start job run containers. If not specified an empty string array will
	// be applied and the arguments specified by the container image, will be used to start the container.
	RunArguments []string `json:"run_arguments" validate:"required"`

	// The user ID (UID) to run the job (e.g., 1001).
	RunAsUser *int64 `json:"run_as_user,omitempty"`

	// Set commands for the job that are passed to start job run containers. If not specified an empty string array will be
	// applied and the command specified by the container image, will be used to start the container.
	RunCommands []string `json:"run_commands" validate:"required"`

	// References to config maps, secrets or literal values, which are exposed as environment variables in the job run.
	RunEnvVariables []EnvVar `json:"run_env_variables" validate:"required"`

	// The mode for runs of the job. Valid values are `task` and `daemon`. In `task` mode, the `max_execution_time` and
	// `retry_limit` properties apply. In `daemon` mode, since there is no timeout and failed instances are restarted
	// indefinitely, the `max_execution_time` and `retry_limit` properties are not allowed.
	RunMode *string `json:"run_mode,omitempty"`

	// The name of the service account. For built-in service accounts, you can use the shortened names `manager`, `none`,
	// `reader`, and `writer`. This property must not be set on a job run, which references a job template.
	RunServiceAccount *string `json:"run_service_account,omitempty"`

	// Optional mounts of config maps or a secrets.
	RunVolumeMounts []VolumeMount `json:"run_volume_mounts" validate:"required"`

	// Optional value to override the JOB_ARRAY_SIZE environment variable for a job run.
	ScaleArraySizeVariableOverride *int64 `json:"scale_array_size_variable_override,omitempty"`

	// Define a custom set of array indices as comma-separated list containing single values and hyphen-separated ranges
	// like `5,12-14,23,27`. Each instance can pick up its array index via environment variable `JOB_INDEX`. The number of
	// unique array indices specified here determines the number of job instances to run.
	ScaleArraySpec *string `json:"scale_array_spec,omitempty"`

	// Optional amount of CPU set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo).
	ScaleCpuLimit *string `json:"scale_cpu_limit,omitempty"`

	// Optional amount of ephemeral storage to set for the instance of the job. The amount specified as ephemeral storage,
	// must not exceed the amount of `scale_memory_limit`. The units for specifying ephemeral storage are Megabyte (M) or
	// Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information see [Units of
	// measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleEphemeralStorageLimit *string `json:"scale_ephemeral_storage_limit,omitempty"`

	// The maximum execution time in seconds for runs of the job. This property can only be specified if `run_mode` is
	// `task`.
	ScaleMaxExecutionTime *int64 `json:"scale_max_execution_time,omitempty"`

	// Optional amount of memory set for the instance of the job. For valid values see [Supported memory and CPU
	// combinations](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo). The units for specifying memory
	// are Megabyte (M) or Gigabyte (G), whereas G and M are the shorthand expressions for GB and MB. For more information
	// see [Units of measurement](https://cloud.ibm.com/docs/codeengine?topic=codeengine-mem-cpu-combo#unit-measurements).
	ScaleMemoryLimit *string `json:"scale_memory_limit,omitempty"`

	// The number of times to rerun an instance of the job before the job is marked as failed. This property can only be
	// specified if `run_mode` is `task`.
	ScaleRetryLimit *int64 `json:"scale_retry_limit,omitempty"`

	// The current status of the job run.
	Status *string `json:"status,omitempty"`

	// The detailed status of the job run.
	StatusDetails *JobRunStatus `json:"status_details,omitempty"`
}

JobRun : Response model for job run resources.

type JobRunList 

type JobRunList struct {
	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// List of all jobs.
	JobRuns []JobRun `json:"job_runs" validate:"required"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`
}

JobRunList : Contains a list of job runs and pagination information.

func (*JobRunList) GetNextStart 

func (resp *JobRunList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type JobRunStatus 

type JobRunStatus struct {
	// Time the job run completed.
	CompletionTime *string `json:"completion_time,omitempty"`

	// Number of failed job run instances.
	Failed *int64 `json:"failed,omitempty"`

	// Number of pending job run instances.
	Pending *int64 `json:"pending,omitempty"`

	// Number of requested job run instances.
	Requested *int64 `json:"requested,omitempty"`

	// Number of running job run instances.
	Running *int64 `json:"running,omitempty"`

	// Time the job run started.
	StartTime *string `json:"start_time,omitempty"`

	// Number of succeeded job run instances.
	Succeeded *int64 `json:"succeeded,omitempty"`

	// Number of job run instances with unknown state.
	Unknown *int64 `json:"unknown,omitempty"`
}

JobRunStatus : The detailed status of the job run.

type JobRunsPager 

type JobRunsPager struct {
	// contains filtered or unexported fields
}

JobRunsPager can be used to simplify the use of the "ListJobRuns" method.

func (*JobRunsPager) GetAll 

func (pager *JobRunsPager) GetAll() (allItems []JobRun, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*JobRunsPager) GetAllWithContext 

func (pager *JobRunsPager) GetAllWithContext(ctx context.Context) (allItems []JobRun, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*JobRunsPager) GetNext 

func (pager *JobRunsPager) GetNext() (page []JobRun, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*JobRunsPager) GetNextWithContext 

func (pager *JobRunsPager) GetNextWithContext(ctx context.Context) (page []JobRun, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*JobRunsPager) HasNext 

func (pager *JobRunsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type JobsPager 

type JobsPager struct {
	// contains filtered or unexported fields
}

JobsPager can be used to simplify the use of the "ListJobs" method.

func (*JobsPager) GetAll 

func (pager *JobsPager) GetAll() (allItems []Job, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*JobsPager) GetAllWithContext 

func (pager *JobsPager) GetAllWithContext(ctx context.Context) (allItems []Job, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*JobsPager) GetNext 

func (pager *JobsPager) GetNext() (page []Job, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*JobsPager) GetNextWithContext 

func (pager *JobsPager) GetNextWithContext(ctx context.Context) (page []Job, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*JobsPager) HasNext 

func (pager *JobsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ListAppRevisionsOptions 

type ListAppRevisionsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	AppName *string `json:"app_name" validate:"required,ne="`

	// Optional maximum number of apps per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAppRevisionsOptions : The ListAppRevisions options.

func (*ListAppRevisionsOptions) SetAppName 

func (_options *ListAppRevisionsOptions) SetAppName(appName string) *ListAppRevisionsOptions

SetAppName : Allow user to set AppName

func (*ListAppRevisionsOptions) SetHeaders 

func (options *ListAppRevisionsOptions) SetHeaders(param map[string]string) *ListAppRevisionsOptions

SetHeaders : Allow user to set Headers

func (*ListAppRevisionsOptions) SetLimit 

func (_options *ListAppRevisionsOptions) SetLimit(limit int64) *ListAppRevisionsOptions

SetLimit : Allow user to set Limit

func (*ListAppRevisionsOptions) SetProjectID 

func (_options *ListAppRevisionsOptions) SetProjectID(projectID string) *ListAppRevisionsOptions

SetProjectID : Allow user to set ProjectID

func (*ListAppRevisionsOptions) SetStart 

func (_options *ListAppRevisionsOptions) SetStart(start string) *ListAppRevisionsOptions

SetStart : Allow user to set Start

type ListAppsOptions 

type ListAppsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of apps per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListAppsOptions : The ListApps options.

func (*ListAppsOptions) SetHeaders 

func (options *ListAppsOptions) SetHeaders(param map[string]string) *ListAppsOptions

SetHeaders : Allow user to set Headers

func (*ListAppsOptions) SetLimit 

func (_options *ListAppsOptions) SetLimit(limit int64) *ListAppsOptions

SetLimit : Allow user to set Limit

func (*ListAppsOptions) SetProjectID 

func (_options *ListAppsOptions) SetProjectID(projectID string) *ListAppsOptions

SetProjectID : Allow user to set ProjectID

func (*ListAppsOptions) SetStart 

func (_options *ListAppsOptions) SetStart(start string) *ListAppsOptions

SetStart : Allow user to set Start

type ListBindingsOptions 

type ListBindingsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of bindings per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBindingsOptions : The ListBindings options.

func (*ListBindingsOptions) SetHeaders 

func (options *ListBindingsOptions) SetHeaders(param map[string]string) *ListBindingsOptions

SetHeaders : Allow user to set Headers

func (*ListBindingsOptions) SetLimit 

func (_options *ListBindingsOptions) SetLimit(limit int64) *ListBindingsOptions

SetLimit : Allow user to set Limit

func (*ListBindingsOptions) SetProjectID 

func (_options *ListBindingsOptions) SetProjectID(projectID string) *ListBindingsOptions

SetProjectID : Allow user to set ProjectID

func (*ListBindingsOptions) SetStart 

func (_options *ListBindingsOptions) SetStart(start string) *ListBindingsOptions

SetStart : Allow user to set Start

type ListBuildRunsOptions 

type ListBuildRunsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional name of the build that should be filtered for.
	BuildName *string `json:"build_name,omitempty"`

	// Optional maximum number of build runs per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBuildRunsOptions : The ListBuildRuns options.

func (*ListBuildRunsOptions) SetBuildName 

func (_options *ListBuildRunsOptions) SetBuildName(buildName string) *ListBuildRunsOptions

SetBuildName : Allow user to set BuildName

func (*ListBuildRunsOptions) SetHeaders 

func (options *ListBuildRunsOptions) SetHeaders(param map[string]string) *ListBuildRunsOptions

SetHeaders : Allow user to set Headers

func (*ListBuildRunsOptions) SetLimit 

func (_options *ListBuildRunsOptions) SetLimit(limit int64) *ListBuildRunsOptions

SetLimit : Allow user to set Limit

func (*ListBuildRunsOptions) SetProjectID 

func (_options *ListBuildRunsOptions) SetProjectID(projectID string) *ListBuildRunsOptions

SetProjectID : Allow user to set ProjectID

func (*ListBuildRunsOptions) SetStart 

func (_options *ListBuildRunsOptions) SetStart(start string) *ListBuildRunsOptions

SetStart : Allow user to set Start

type ListBuildsOptions 

type ListBuildsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of builds per page.
	Limit *int64 `json:"limit,omitempty"`

	// The token to continue traversing paginated list of builds.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListBuildsOptions : The ListBuilds options.

func (*ListBuildsOptions) SetHeaders 

func (options *ListBuildsOptions) SetHeaders(param map[string]string) *ListBuildsOptions

SetHeaders : Allow user to set Headers

func (*ListBuildsOptions) SetLimit 

func (_options *ListBuildsOptions) SetLimit(limit int64) *ListBuildsOptions

SetLimit : Allow user to set Limit

func (*ListBuildsOptions) SetProjectID 

func (_options *ListBuildsOptions) SetProjectID(projectID string) *ListBuildsOptions

SetProjectID : Allow user to set ProjectID

func (*ListBuildsOptions) SetStart 

func (_options *ListBuildsOptions) SetStart(start string) *ListBuildsOptions

SetStart : Allow user to set Start

type ListConfigMapsOptions 

type ListConfigMapsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of config maps per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListConfigMapsOptions : The ListConfigMaps options.

func (*ListConfigMapsOptions) SetHeaders 

func (options *ListConfigMapsOptions) SetHeaders(param map[string]string) *ListConfigMapsOptions

SetHeaders : Allow user to set Headers

func (*ListConfigMapsOptions) SetLimit 

func (_options *ListConfigMapsOptions) SetLimit(limit int64) *ListConfigMapsOptions

SetLimit : Allow user to set Limit

func (*ListConfigMapsOptions) SetProjectID 

func (_options *ListConfigMapsOptions) SetProjectID(projectID string) *ListConfigMapsOptions

SetProjectID : Allow user to set ProjectID

func (*ListConfigMapsOptions) SetStart 

func (_options *ListConfigMapsOptions) SetStart(start string) *ListConfigMapsOptions

SetStart : Allow user to set Start

type ListDomainMappingsOptions 

type ListDomainMappingsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of domain mappings per page.
	Limit *int64 `json:"limit,omitempty"`

	// The token to continue traversing paginated list of domain mappings.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListDomainMappingsOptions : The ListDomainMappings options.

func (*ListDomainMappingsOptions) SetHeaders 

func (options *ListDomainMappingsOptions) SetHeaders(param map[string]string) *ListDomainMappingsOptions

SetHeaders : Allow user to set Headers

func (*ListDomainMappingsOptions) SetLimit 

func (_options *ListDomainMappingsOptions) SetLimit(limit int64) *ListDomainMappingsOptions

SetLimit : Allow user to set Limit

func (*ListDomainMappingsOptions) SetProjectID 

func (_options *ListDomainMappingsOptions) SetProjectID(projectID string) *ListDomainMappingsOptions

SetProjectID : Allow user to set ProjectID

func (*ListDomainMappingsOptions) SetStart 

func (_options *ListDomainMappingsOptions) SetStart(start string) *ListDomainMappingsOptions

SetStart : Allow user to set Start

type ListFirstMetadata 

type ListFirstMetadata struct {
	// Href that points to the first page.
	Href *string `json:"href,omitempty"`
}

ListFirstMetadata : Describes properties needed to retrieve the first page of a result list.

type ListJobRunsOptions 

type ListJobRunsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional name of the job that should be filtered for.
	JobName *string `json:"job_name,omitempty"`

	// Optional maximum number of job runs per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListJobRunsOptions : The ListJobRuns options.

func (*ListJobRunsOptions) SetHeaders 

func (options *ListJobRunsOptions) SetHeaders(param map[string]string) *ListJobRunsOptions

SetHeaders : Allow user to set Headers

func (*ListJobRunsOptions) SetJobName 

func (_options *ListJobRunsOptions) SetJobName(jobName string) *ListJobRunsOptions

SetJobName : Allow user to set JobName

func (*ListJobRunsOptions) SetLimit 

func (_options *ListJobRunsOptions) SetLimit(limit int64) *ListJobRunsOptions

SetLimit : Allow user to set Limit

func (*ListJobRunsOptions) SetProjectID 

func (_options *ListJobRunsOptions) SetProjectID(projectID string) *ListJobRunsOptions

SetProjectID : Allow user to set ProjectID

func (*ListJobRunsOptions) SetStart 

func (_options *ListJobRunsOptions) SetStart(start string) *ListJobRunsOptions

SetStart : Allow user to set Start

type ListJobsOptions 

type ListJobsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of jobs per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListJobsOptions : The ListJobs options.

func (*ListJobsOptions) SetHeaders 

func (options *ListJobsOptions) SetHeaders(param map[string]string) *ListJobsOptions

SetHeaders : Allow user to set Headers

func (*ListJobsOptions) SetLimit 

func (_options *ListJobsOptions) SetLimit(limit int64) *ListJobsOptions

SetLimit : Allow user to set Limit

func (*ListJobsOptions) SetProjectID 

func (_options *ListJobsOptions) SetProjectID(projectID string) *ListJobsOptions

SetProjectID : Allow user to set ProjectID

func (*ListJobsOptions) SetStart 

func (_options *ListJobsOptions) SetStart(start string) *ListJobsOptions

SetStart : Allow user to set Start

type ListNextMetadata 

type ListNextMetadata struct {
	// Href that points to the next page.
	Href *string `json:"href,omitempty"`

	// Token.
	Start *string `json:"start,omitempty"`
}

ListNextMetadata : Describes properties needed to retrieve the next page of a result list.

type ListProjectsOptions 

type ListProjectsOptions struct {
	// Optional maximum number of projects per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. Any additional query
	// parameters are ignored if a page token is present. If omitted, the first page of results is returned. This value is
	// obtained from the 'start' query parameter in the `next` object of the operation response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListProjectsOptions : The ListProjects options.

func (*ListProjectsOptions) SetHeaders 

func (options *ListProjectsOptions) SetHeaders(param map[string]string) *ListProjectsOptions

SetHeaders : Allow user to set Headers

func (*ListProjectsOptions) SetLimit 

func (_options *ListProjectsOptions) SetLimit(limit int64) *ListProjectsOptions

SetLimit : Allow user to set Limit

func (*ListProjectsOptions) SetStart 

func (_options *ListProjectsOptions) SetStart(start string) *ListProjectsOptions

SetStart : Allow user to set Start

type ListSecretsOptions 

type ListSecretsOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// Optional maximum number of secrets per page.
	Limit *int64 `json:"limit,omitempty"`

	// An optional token that indicates the beginning of the page of results to be returned. If omitted, the first page of
	// results is returned. This value is obtained from the 'start' query parameter in the `next` object of the operation
	// response.
	Start *string `json:"start,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListSecretsOptions : The ListSecrets options.

func (*ListSecretsOptions) SetHeaders 

func (options *ListSecretsOptions) SetHeaders(param map[string]string) *ListSecretsOptions

SetHeaders : Allow user to set Headers

func (*ListSecretsOptions) SetLimit 

func (_options *ListSecretsOptions) SetLimit(limit int64) *ListSecretsOptions

SetLimit : Allow user to set Limit

func (*ListSecretsOptions) SetProjectID 

func (_options *ListSecretsOptions) SetProjectID(projectID string) *ListSecretsOptions

SetProjectID : Allow user to set ProjectID

func (*ListSecretsOptions) SetStart 

func (_options *ListSecretsOptions) SetStart(start string) *ListSecretsOptions

SetStart : Allow user to set Start

type OperatorSecretProps 

type OperatorSecretProps struct {
	// The ID of the apikey associated with the operator secret.
	ApikeyID *string `json:"apikey_id" validate:"required"`

	// The list of resource groups (by ID) that the operator secret can bind services in.
	ResourceGroupIds []string `json:"resource_group_ids" validate:"required"`

	// A reference to a Service ID.
	Serviceid *ServiceIDRef `json:"serviceid" validate:"required"`

	// Specifies whether the operator secret is user managed.
	UserManaged *bool `json:"user_managed" validate:"required"`
}

OperatorSecretProps : Properties for the IBM Cloud Operator Secret.

type OperatorSecretPrototypeProps 

type OperatorSecretPrototypeProps struct {
	// The list of resource groups (by ID) that the operator secret can bind services in.
	ResourceGroupIds []string `json:"resource_group_ids,omitempty"`

	// A reference to the Service ID.
	Serviceid *ServiceIDRefPrototype `json:"serviceid,omitempty"`
}

OperatorSecretPrototypeProps : Properties for the IBM Cloud Operator Secret Prototype.

type Probe 

type Probe struct {
	// The number of consecutive, unsuccessful checks for the probe to be considered failed.
	FailureThreshold *int64 `json:"failure_threshold,omitempty"`

	// The amount of time in seconds to wait before the first probe check is performed.
	InitialDelay *int64 `json:"initial_delay,omitempty"`

	// The amount of time in seconds between probe checks.
	Interval *int64 `json:"interval,omitempty"`

	// The path of the HTTP request to the resource. A path is only supported for a probe with a `type` of `http`.
	Path *string `json:"path,omitempty"`

	// The port on which to probe the resource.
	Port *int64 `json:"port,omitempty"`

	// The amount of time in seconds that the probe waits for a response from the application before it times out and
	// fails.
	Timeout *int64 `json:"timeout,omitempty"`

	// Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
	Type *string `json:"type,omitempty"`
}

Probe : Response model for probes.

type ProbePrototype 

type ProbePrototype struct {
	// The number of consecutive, unsuccessful checks for the probe to be considered failed.
	FailureThreshold *int64 `json:"failure_threshold,omitempty"`

	// The amount of time in seconds to wait before the first probe check is performed.
	InitialDelay *int64 `json:"initial_delay,omitempty"`

	// The amount of time in seconds between probe checks.
	Interval *int64 `json:"interval,omitempty"`

	// The path of the HTTP request to the resource. A path is only supported for a probe with a `type` of `http`.
	Path *string `json:"path,omitempty"`

	// The port on which to probe the resource.
	Port *int64 `json:"port,omitempty"`

	// The amount of time in seconds that the probe waits for a response from the application before it times out and
	// fails.
	Timeout *int64 `json:"timeout,omitempty"`

	// Specifies whether to use HTTP or TCP for the probe checks. The default is TCP.
	Type *string `json:"type,omitempty"`
}

ProbePrototype : Request model for probes.

type Project 

type Project struct {
	// An alphanumeric value identifying the account ID.
	AccountID *string `json:"account_id,omitempty"`

	// The timestamp when the project was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// The CRN of the project.
	Crn *string `json:"crn,omitempty"`

	// When you provision a new resource, a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The ID of the project.
	ID *string `json:"id,omitempty"`

	// The name of the project.
	Name *string `json:"name" validate:"required"`

	// The region for your project deployment. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de', 'eu-gb', 'jp-osa',
	// 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The ID of the resource group.
	ResourceGroupID *string `json:"resource_group_id" validate:"required"`

	// The type of the project.
	ResourceType *string `json:"resource_type,omitempty"`

	// The current state of the project. For example, if the project is created and ready to get used, it will return
	// active.
	Status *string `json:"status,omitempty"`
}

Project : Describes the model of a project.

type ProjectEgressIPAddresses 

type ProjectEgressIPAddresses struct {
	// List of IBM private network IP addresses.
	Private []string `json:"private,omitempty"`

	// List of public IP addresses.
	Public []string `json:"public,omitempty"`
}

ProjectEgressIPAddresses : Describes the model of egress IP addresses.

type ProjectList 

type ProjectList struct {
	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`

	// List of projects.
	Projects []Project `json:"projects" validate:"required"`
}

ProjectList : Contains a list of projects and pagination information.

func (*ProjectList) GetNextStart 

func (resp *ProjectList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type ProjectStatusDetails 

type ProjectStatusDetails struct {
	// Status of the domain created for the project.
	Domain *string `json:"domain" validate:"required"`

	// Defines whether a project is enabled for management and consumption.
	Project *string `json:"project" validate:"required"`
}

ProjectStatusDetails : Describes the model of a project status details.

type ProjectsPager 

type ProjectsPager struct {
	// contains filtered or unexported fields
}

ProjectsPager can be used to simplify the use of the "ListProjects" method.

func (*ProjectsPager) GetAll 

func (pager *ProjectsPager) GetAll() (allItems []Project, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*ProjectsPager) GetAllWithContext 

func (pager *ProjectsPager) GetAllWithContext(ctx context.Context) (allItems []Project, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*ProjectsPager) GetNext 

func (pager *ProjectsPager) GetNext() (page []Project, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*ProjectsPager) GetNextWithContext 

func (pager *ProjectsPager) GetNextWithContext(ctx context.Context) (page []Project, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*ProjectsPager) HasNext 

func (pager *ProjectsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ReplaceConfigMapOptions 

type ReplaceConfigMapOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your configmap.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the config map settings to be updated. Specify the version that you retrieved as entity_tag (ETag header)
	// when reading the config map. This value helps identifying parallel usage of this API. Pass * to indicate to update
	// any version available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The key-value pair for the config map. Values must be specified in `KEY=VALUE` format. Each `KEY` field must consist
	// of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each `VALUE`
	// field can consists of any character and must not be exceed a max length of 1048576 characters.
	Data map[string]string `json:"data,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceConfigMapOptions : The ReplaceConfigMap options.

func (*ReplaceConfigMapOptions) SetData 

func (_options *ReplaceConfigMapOptions) SetData(data map[string]string) *ReplaceConfigMapOptions

SetData : Allow user to set Data

func (*ReplaceConfigMapOptions) SetHeaders 

func (options *ReplaceConfigMapOptions) SetHeaders(param map[string]string) *ReplaceConfigMapOptions

SetHeaders : Allow user to set Headers

func (*ReplaceConfigMapOptions) SetIfMatch 

func (_options *ReplaceConfigMapOptions) SetIfMatch(ifMatch string) *ReplaceConfigMapOptions

SetIfMatch : Allow user to set IfMatch

func (*ReplaceConfigMapOptions) SetName 

func (_options *ReplaceConfigMapOptions) SetName(name string) *ReplaceConfigMapOptions

SetName : Allow user to set Name

func (*ReplaceConfigMapOptions) SetProjectID 

func (_options *ReplaceConfigMapOptions) SetProjectID(projectID string) *ReplaceConfigMapOptions

SetProjectID : Allow user to set ProjectID

type ReplaceSecretOptions 

type ReplaceSecretOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your secret.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the secret settings to be updated. Specify the version that you retrieved as entity_tag (ETag header)
	// when reading the secret. This value helps identifying parallel usage of this API. Pass * to indicate to update any
	// version available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Specify the format of the secret. The format of the secret will determine how the secret is used.
	Format *string `json:"format" validate:"required"`

	// Data container that allows to specify config parameters and their values as a key-value map. Each key field must
	// consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value
	// field can consists of any character and must not exceed a max length of 1048576 characters.
	Data SecretDataIntf `json:"data,omitempty"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

ReplaceSecretOptions : The ReplaceSecret options.

func (*ReplaceSecretOptions) SetData 

func (_options *ReplaceSecretOptions) SetData(data SecretDataIntf) *ReplaceSecretOptions

SetData : Allow user to set Data

func (*ReplaceSecretOptions) SetFormat 

func (_options *ReplaceSecretOptions) SetFormat(format string) *ReplaceSecretOptions

SetFormat : Allow user to set Format

func (*ReplaceSecretOptions) SetHeaders 

func (options *ReplaceSecretOptions) SetHeaders(param map[string]string) *ReplaceSecretOptions

SetHeaders : Allow user to set Headers

func (*ReplaceSecretOptions) SetIfMatch 

func (_options *ReplaceSecretOptions) SetIfMatch(ifMatch string) *ReplaceSecretOptions

SetIfMatch : Allow user to set IfMatch

func (*ReplaceSecretOptions) SetName 

func (_options *ReplaceSecretOptions) SetName(name string) *ReplaceSecretOptions

SetName : Allow user to set Name

func (*ReplaceSecretOptions) SetProjectID 

func (_options *ReplaceSecretOptions) SetProjectID(projectID string) *ReplaceSecretOptions

SetProjectID : Allow user to set ProjectID

type ResourceKeyRef 

type ResourceKeyRef struct {
	// ID of the service credential associated with the secret.
	ID *string `json:"id,omitempty"`

	// Name of the service credential associated with the secret.
	Name *string `json:"name,omitempty"`
}

ResourceKeyRef : The service credential associated with the secret.

type ResourceKeyRefPrototype 

type ResourceKeyRefPrototype struct {
	// ID of the service credential associated with the secret.
	ID *string `json:"id,omitempty"`
}

ResourceKeyRefPrototype : The service credential associated with the secret.

type RoleRef 

type RoleRef struct {
	// CRN of the IAM Role for this service access secret.
	Crn *string `json:"crn,omitempty"`

	// Role of the service credential.
	Name *string `json:"name,omitempty"`
}

RoleRef : A reference to the Role and Role CRN for service binding.

type RoleRefPrototype 

type RoleRefPrototype struct {
	// CRN of the IAM Role for this service access secret.
	Crn *string `json:"crn,omitempty"`
}

RoleRefPrototype : A reference to the Role and Role CRN for service binding.

type Secret 

type Secret struct {
	// The timestamp when the resource was created.
	CreatedAt *string `json:"created_at,omitempty"`

	// Data container that allows to specify config parameters and their values as a key-value map. Each key field must
	// consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value
	// field can consists of any character and must not exceed a max length of 1048576 characters.
	Data map[string]string `json:"data,omitempty"`

	// The version of the secret instance, which is used to achieve optimistic locking.
	EntityTag *string `json:"entity_tag" validate:"required"`

	// Specify the format of the secret.
	Format *string `json:"format,omitempty"`

	// When you provision a new secret,  a URL is created identifying the location of the instance.
	Href *string `json:"href,omitempty"`

	// The identifier of the resource.
	ID *string `json:"id,omitempty"`

	// The name of the secret.
	Name *string `json:"name" validate:"required"`

	// The ID of the project the resource is located in.
	ProjectID *string `json:"project_id,omitempty"`

	// The region of the project the resource is located in. Possible values: 'au-syd', 'br-sao', 'ca-tor', 'eu-de',
	// 'eu-gb', 'jp-osa', 'jp-tok', 'us-east', 'us-south'.
	Region *string `json:"region,omitempty"`

	// The type of the secret.
	ResourceType *string `json:"resource_type,omitempty"`

	// Properties for Service Access Secrets.
	ServiceAccess *ServiceAccessSecretProps `json:"service_access,omitempty"`

	// Properties for the IBM Cloud Operator Secret.
	ServiceOperator *OperatorSecretProps `json:"service_operator,omitempty"`
}

Secret : Describes the model of a secret.

type SecretData 

type SecretData struct {
	// SSH key.
	SshKey *string `json:"ssh_key,omitempty"`

	// Known hosts.
	KnownHosts *string `json:"known_hosts,omitempty"`

	// Registry username.
	Username *string `json:"username,omitempty"`

	// Registry password.
	Password *string `json:"password,omitempty"`

	// Registry server.
	Server *string `json:"server,omitempty"`

	// Registry email address.
	Email *string `json:"email,omitempty"`

	// The TLS certificate used in a TLS secret.
	TlsCert *string `json:"tls_cert,omitempty"`

	// The TLS key used in a TLS secret.
	TlsKey *string `json:"tls_key,omitempty"`
	// contains filtered or unexported fields
}

SecretData : Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not exceed a max length of 253 characters. Each value field can consists of any character and must not exceed a max length of 1048576 characters. Models which "extend" this model: - SecretDataSSHSecretData - SecretDataRegistrySecretData - SecretDataTLSSecretData - SecretDataGenericSecretData - SecretDataBasicAuthSecretData

func (*SecretData) GetProperties 

func (o *SecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretData

func (*SecretData) GetProperty 

func (o *SecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretData

func (*SecretData) MarshalJSON 

func (o *SecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretData

func (*SecretData) SetProperties 

func (o *SecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretData

func (*SecretData) SetProperty 

func (o *SecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretData

type SecretDataBasicAuthSecretData 

type SecretDataBasicAuthSecretData struct {
	// Basic auth username.
	Username *string `json:"username" validate:"required"`

	// Basic auth password.
	Password *string `json:"password" validate:"required"`
	// contains filtered or unexported fields
}

SecretDataBasicAuthSecretData : SecretDataBasicAuthSecretData struct This model "extends" SecretData

func (*SecretDataBasicAuthSecretData) GetProperties 

func (o *SecretDataBasicAuthSecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretDataBasicAuthSecretData

func (*SecretDataBasicAuthSecretData) GetProperty 

func (o *SecretDataBasicAuthSecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretDataBasicAuthSecretData

func (*SecretDataBasicAuthSecretData) MarshalJSON 

func (o *SecretDataBasicAuthSecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretDataBasicAuthSecretData

func (*SecretDataBasicAuthSecretData) SetProperties 

func (o *SecretDataBasicAuthSecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretDataBasicAuthSecretData

func (*SecretDataBasicAuthSecretData) SetProperty 

func (o *SecretDataBasicAuthSecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretDataBasicAuthSecretData

type SecretDataGenericSecretData 

type SecretDataGenericSecretData struct {
	// contains filtered or unexported fields
}

SecretDataGenericSecretData : Data container that allows to specify config parameters and their values as a key-value map. Each key field must consist of alphanumeric characters, `-`, `_` or `.` and must not be exceed a max length of 253 characters. Each value field can consists of any character and must not be exceed a max length of 1048576 characters. This model "extends" SecretData

func (*SecretDataGenericSecretData) GetProperties 

func (o *SecretDataGenericSecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretDataGenericSecretData

func (*SecretDataGenericSecretData) GetProperty 

func (o *SecretDataGenericSecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretDataGenericSecretData

func (*SecretDataGenericSecretData) MarshalJSON 

func (o *SecretDataGenericSecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretDataGenericSecretData

func (*SecretDataGenericSecretData) SetProperties 

func (o *SecretDataGenericSecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretDataGenericSecretData

func (*SecretDataGenericSecretData) SetProperty 

func (o *SecretDataGenericSecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretDataGenericSecretData

type SecretDataIntf 

type SecretDataIntf interface {
	SetProperty(key string, value *string)
	SetProperties(m map[string]*string)
	GetProperty(key string) *string
	GetProperties() map[string]*string
	// contains filtered or unexported methods
}

type SecretDataRegistrySecretData 

type SecretDataRegistrySecretData struct {
	// Registry username.
	Username *string `json:"username" validate:"required"`

	// Registry password.
	Password *string `json:"password" validate:"required"`

	// Registry server.
	Server *string `json:"server" validate:"required"`

	// Registry email address.
	Email *string `json:"email" validate:"required"`
	// contains filtered or unexported fields
}

SecretDataRegistrySecretData : SecretDataRegistrySecretData struct This model "extends" SecretData

func (*SecretDataRegistrySecretData) GetProperties 

func (o *SecretDataRegistrySecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretDataRegistrySecretData

func (*SecretDataRegistrySecretData) GetProperty 

func (o *SecretDataRegistrySecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretDataRegistrySecretData

func (*SecretDataRegistrySecretData) MarshalJSON 

func (o *SecretDataRegistrySecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretDataRegistrySecretData

func (*SecretDataRegistrySecretData) SetProperties 

func (o *SecretDataRegistrySecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretDataRegistrySecretData

func (*SecretDataRegistrySecretData) SetProperty 

func (o *SecretDataRegistrySecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretDataRegistrySecretData

type SecretDataSSHSecretData 

type SecretDataSSHSecretData struct {
	// SSH key.
	SshKey *string `json:"ssh_key" validate:"required"`

	// Known hosts.
	KnownHosts *string `json:"known_hosts,omitempty"`
	// contains filtered or unexported fields
}

SecretDataSSHSecretData : Secret Data field used by SSH secrets. This model "extends" SecretData

func (*SecretDataSSHSecretData) GetProperties 

func (o *SecretDataSSHSecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretDataSSHSecretData

func (*SecretDataSSHSecretData) GetProperty 

func (o *SecretDataSSHSecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretDataSSHSecretData

func (*SecretDataSSHSecretData) MarshalJSON 

func (o *SecretDataSSHSecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretDataSSHSecretData

func (*SecretDataSSHSecretData) SetProperties 

func (o *SecretDataSSHSecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretDataSSHSecretData

func (*SecretDataSSHSecretData) SetProperty 

func (o *SecretDataSSHSecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretDataSSHSecretData

type SecretDataTLSSecretData 

type SecretDataTLSSecretData struct {
	// The TLS certificate used in a TLS secret.
	TlsCert *string `json:"tls_cert" validate:"required"`

	// The TLS key used in a TLS secret.
	TlsKey *string `json:"tls_key" validate:"required"`
	// contains filtered or unexported fields
}

SecretDataTLSSecretData : SecretDataTLSSecretData struct This model "extends" SecretData

func (*SecretDataTLSSecretData) GetProperties 

func (o *SecretDataTLSSecretData) GetProperties() map[string]*string

GetProperties allows the user to retrieve the map of arbitrary properties from an instance of SecretDataTLSSecretData

func (*SecretDataTLSSecretData) GetProperty 

func (o *SecretDataTLSSecretData) GetProperty(key string) *string

GetProperty allows the user to retrieve an arbitrary property from an instance of SecretDataTLSSecretData

func (*SecretDataTLSSecretData) MarshalJSON 

func (o *SecretDataTLSSecretData) MarshalJSON() (buffer []byte, err error)

MarshalJSON performs custom serialization for instances of SecretDataTLSSecretData

func (*SecretDataTLSSecretData) SetProperties 

func (o *SecretDataTLSSecretData) SetProperties(m map[string]*string)

SetProperties allows the user to set a map of arbitrary properties on an instance of SecretDataTLSSecretData

func (*SecretDataTLSSecretData) SetProperty 

func (o *SecretDataTLSSecretData) SetProperty(key string, value *string)

SetProperty allows the user to set an arbitrary property on an instance of SecretDataTLSSecretData

type SecretList 

type SecretList struct {
	// Describes properties needed to retrieve the first page of a result list.
	First *ListFirstMetadata `json:"first,omitempty"`

	// Maximum number of resources per page.
	Limit *int64 `json:"limit" validate:"required"`

	// Describes properties needed to retrieve the next page of a result list.
	Next *ListNextMetadata `json:"next,omitempty"`

	// List of Secrets.
	Secrets []Secret `json:"secrets" validate:"required"`
}

SecretList : List of secret resources.

func (*SecretList) GetNextStart 

func (resp *SecretList) GetNextStart() (*string, error)

Retrieve the value to be passed to a request to access the next page of results

type SecretsPager 

type SecretsPager struct {
	// contains filtered or unexported fields
}

SecretsPager can be used to simplify the use of the "ListSecrets" method.

func (*SecretsPager) GetAll 

func (pager *SecretsPager) GetAll() (allItems []Secret, err error)

GetAll invokes GetAllWithContext() using context.Background() as the Context parameter.

func (*SecretsPager) GetAllWithContext 

func (pager *SecretsPager) GetAllWithContext(ctx context.Context) (allItems []Secret, err error)

GetAllWithContext returns all results by invoking GetNextWithContext() repeatedly until all pages of results have been retrieved.

func (*SecretsPager) GetNext 

func (pager *SecretsPager) GetNext() (page []Secret, err error)

GetNext invokes GetNextWithContext() using context.Background() as the Context parameter.

func (*SecretsPager) GetNextWithContext 

func (pager *SecretsPager) GetNextWithContext(ctx context.Context) (page []Secret, err error)

GetNextWithContext returns the next page of results using the specified Context.

func (*SecretsPager) HasNext 

func (pager *SecretsPager) HasNext() bool

HasNext returns true if there are potentially more results to be retrieved.

type ServiceAccessSecretProps 

type ServiceAccessSecretProps struct {
	// The service credential associated with the secret.
	ResourceKey *ResourceKeyRef `json:"resource_key" validate:"required"`

	// A reference to the Role and Role CRN for service binding.
	Role *RoleRef `json:"role,omitempty"`

	// The IBM Cloud service instance associated with the secret.
	ServiceInstance *ServiceInstanceRef `json:"service_instance" validate:"required"`

	// A reference to a Service ID.
	Serviceid *ServiceIDRef `json:"serviceid,omitempty"`
}

ServiceAccessSecretProps : Properties for Service Access Secrets.

type ServiceAccessSecretPrototypeProps 

type ServiceAccessSecretPrototypeProps struct {
	// The service credential associated with the secret.
	ResourceKey *ResourceKeyRefPrototype `json:"resource_key" validate:"required"`

	// A reference to the Role and Role CRN for service binding.
	Role *RoleRefPrototype `json:"role,omitempty"`

	// The IBM Cloud service instance associated with the secret.
	ServiceInstance *ServiceInstanceRefPrototype `json:"service_instance" validate:"required"`

	// A reference to a Service ID.
	Serviceid *ServiceIDRef `json:"serviceid,omitempty"`
}

ServiceAccessSecretPrototypeProps : Properties for Service Access Secret Prototypes.

type ServiceIDRef 

type ServiceIDRef struct {
	// CRN value of a Service ID.
	Crn *string `json:"crn,omitempty"`

	// The ID of the Service ID.
	ID *string `json:"id,omitempty"`
}

ServiceIDRef : A reference to a Service ID.

type ServiceIDRefPrototype 

type ServiceIDRefPrototype struct {
	// The ID of the Service ID.
	ID *string `json:"id,omitempty"`
}

ServiceIDRefPrototype : A reference to the Service ID.

type ServiceInstanceRef 

type ServiceInstanceRef struct {
	// ID of the IBM Cloud service instance associated with the secret.
	ID *string `json:"id,omitempty"`

	// Type of IBM Cloud service associated with the secret.
	Type *string `json:"type,omitempty"`
}

ServiceInstanceRef : The IBM Cloud service instance associated with the secret.

type ServiceInstanceRefPrototype 

type ServiceInstanceRefPrototype struct {
	// ID of the IBM Cloud service instance associated with the secret.
	ID *string `json:"id,omitempty"`
}

ServiceInstanceRefPrototype : The IBM Cloud service instance associated with the secret.

type UpdateAppOptions 

type UpdateAppOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your application.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the app settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the app. This value helps identifying parallel usage of this API. Pass * to indicate to update any version
	// available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// App patch.
	App map[string]interface{} `json:"app" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateAppOptions : The UpdateApp options.

func (*UpdateAppOptions) SetApp 

func (_options *UpdateAppOptions) SetApp(app map[string]interface{}) *UpdateAppOptions

SetApp : Allow user to set App

func (*UpdateAppOptions) SetHeaders 

func (options *UpdateAppOptions) SetHeaders(param map[string]string) *UpdateAppOptions

SetHeaders : Allow user to set Headers

func (*UpdateAppOptions) SetIfMatch 

func (_options *UpdateAppOptions) SetIfMatch(ifMatch string) *UpdateAppOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateAppOptions) SetName 

func (_options *UpdateAppOptions) SetName(name string) *UpdateAppOptions

SetName : Allow user to set Name

func (*UpdateAppOptions) SetProjectID 

func (_options *UpdateAppOptions) SetProjectID(projectID string) *UpdateAppOptions

SetProjectID : Allow user to set ProjectID

type UpdateBuildOptions 

type UpdateBuildOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your build.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the build settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the build. This value helps identifying parallel usage of this API. Pass * to indicate to update any version
	// available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Build patch.
	Build map[string]interface{} `json:"build" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateBuildOptions : The UpdateBuild options.

func (*UpdateBuildOptions) SetBuild 

func (_options *UpdateBuildOptions) SetBuild(build map[string]interface{}) *UpdateBuildOptions

SetBuild : Allow user to set Build

func (*UpdateBuildOptions) SetHeaders 

func (options *UpdateBuildOptions) SetHeaders(param map[string]string) *UpdateBuildOptions

SetHeaders : Allow user to set Headers

func (*UpdateBuildOptions) SetIfMatch 

func (_options *UpdateBuildOptions) SetIfMatch(ifMatch string) *UpdateBuildOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateBuildOptions) SetName 

func (_options *UpdateBuildOptions) SetName(name string) *UpdateBuildOptions

SetName : Allow user to set Name

func (*UpdateBuildOptions) SetProjectID 

func (_options *UpdateBuildOptions) SetProjectID(projectID string) *UpdateBuildOptions

SetProjectID : Allow user to set ProjectID

type UpdateDomainMappingOptions 

type UpdateDomainMappingOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your domain mapping.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the domain mapping to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the domain mapping. This value helps identify parallel usage of this API. Pass * to indicate to update any
	// version available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// DomainMapping patch.
	DomainMapping map[string]interface{} `json:"domain_mapping" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateDomainMappingOptions : The UpdateDomainMapping options.

func (*UpdateDomainMappingOptions) SetDomainMapping 

func (_options *UpdateDomainMappingOptions) SetDomainMapping(domainMapping map[string]interface{}) *UpdateDomainMappingOptions

SetDomainMapping : Allow user to set DomainMapping

func (*UpdateDomainMappingOptions) SetHeaders 

func (options *UpdateDomainMappingOptions) SetHeaders(param map[string]string) *UpdateDomainMappingOptions

SetHeaders : Allow user to set Headers

func (*UpdateDomainMappingOptions) SetIfMatch 

func (_options *UpdateDomainMappingOptions) SetIfMatch(ifMatch string) *UpdateDomainMappingOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateDomainMappingOptions) SetName 

func (_options *UpdateDomainMappingOptions) SetName(name string) *UpdateDomainMappingOptions

SetName : Allow user to set Name

func (*UpdateDomainMappingOptions) SetProjectID 

func (_options *UpdateDomainMappingOptions) SetProjectID(projectID string) *UpdateDomainMappingOptions

SetProjectID : Allow user to set ProjectID

type UpdateJobOptions 

type UpdateJobOptions struct {
	// The ID of the project.
	ProjectID *string `json:"project_id" validate:"required,ne="`

	// The name of your job.
	Name *string `json:"name" validate:"required,ne="`

	// Version of the job settings to be updated. Specify the version that you retrieved as entity_tag (ETag header) when
	// reading the job. This value helps identifying parallel usage of this API. Pass * to indicate to update any version
	// available. This might result in stale updates.
	IfMatch *string `json:"If-Match" validate:"required"`

	// Job patch prototype.
	Job map[string]interface{} `json:"job" validate:"required"`

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateJobOptions : The UpdateJob options.

func (*UpdateJobOptions) SetHeaders 

func (options *UpdateJobOptions) SetHeaders(param map[string]string) *UpdateJobOptions

SetHeaders : Allow user to set Headers

func (*UpdateJobOptions) SetIfMatch 

func (_options *UpdateJobOptions) SetIfMatch(ifMatch string) *UpdateJobOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateJobOptions) SetJob 

func (_options *UpdateJobOptions) SetJob(job map[string]interface{}) *UpdateJobOptions

SetJob : Allow user to set Job

func (*UpdateJobOptions) SetName 

func (_options *UpdateJobOptions) SetName(name string) *UpdateJobOptions

SetName : Allow user to set Name

func (*UpdateJobOptions) SetProjectID 

func (_options *UpdateJobOptions) SetProjectID(projectID string) *UpdateJobOptions

SetProjectID : Allow user to set ProjectID

type VolumeMount 

type VolumeMount struct {
	// The path that should be mounted.
	MountPath *string `json:"mount_path" validate:"required"`

	// The name of the mount.
	Name *string `json:"name" validate:"required"`

	// The name of the referenced secret or config map.
	Reference *string `json:"reference" validate:"required"`

	// Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
	Type *string `json:"type" validate:"required"`
}

VolumeMount : Response model of a volume mount.

type VolumeMountPrototype 

type VolumeMountPrototype struct {
	// The path that should be mounted.
	MountPath *string `json:"mount_path" validate:"required"`

	// Optional name of the mount. If not set, it will be generated based on the `ref` and a random ID. In case the `ref`
	// is longer than 58 characters, it will be cut off.
	Name *string `json:"name,omitempty"`

	// The name of the referenced secret or config map.
	Reference *string `json:"reference" validate:"required"`

	// Specify the type of the volume mount. Allowed types are: 'config_map', 'secret'.
	Type *string `json:"type" validate:"required"`
}

VolumeMountPrototype : Prototype model of a volume mount.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.