Documentation

CreateBucketRequest extends Message
in package

Generated from protobuf message <code>couchbase.admin.bucket.v1.CreateBucketRequest</code>

Table of Contents

$bucket_name  : mixed
Generated from protobuf field <code>string bucket_name = 1;</code>
$bucket_type  : mixed
Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>
$compression_mode  : mixed
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>
$conflict_resolution_type  : mixed
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>
$eviction_mode  : mixed
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>
$flush_enabled  : mixed
Generated from protobuf field <code>optional bool flush_enabled = 5;</code>
$max_expiry_secs  : mixed
Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>
$minimum_durability_level  : mixed
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>
$num_replicas  : mixed
Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>
$ram_quota_mb  : mixed
Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>
$replica_indexes  : mixed
Generated from protobuf field <code>optional bool replica_indexes = 6;</code>
$storage_backend  : mixed
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>
__construct()  : mixed
Constructor.
clearCompressionMode()  : mixed
clearConflictResolutionType()  : mixed
clearEvictionMode()  : mixed
clearFlushEnabled()  : mixed
clearMaxExpirySecs()  : mixed
clearMinimumDurabilityLevel()  : mixed
clearNumReplicas()  : mixed
clearRamQuotaMb()  : mixed
clearReplicaIndexes()  : mixed
clearStorageBackend()  : mixed
getBucketName()  : string
Generated from protobuf field <code>string bucket_name = 1;</code>
getBucketType()  : int
Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>
getCompressionMode()  : int
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>
getConflictResolutionType()  : int
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>
getEvictionMode()  : int
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>
getFlushEnabled()  : bool
Generated from protobuf field <code>optional bool flush_enabled = 5;</code>
getMaxExpirySecs()  : int
Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>
getMinimumDurabilityLevel()  : int
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>
getNumReplicas()  : int
Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>
getRamQuotaMb()  : int|string
Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>
getReplicaIndexes()  : bool
Generated from protobuf field <code>optional bool replica_indexes = 6;</code>
getStorageBackend()  : int
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>
hasCompressionMode()  : mixed
hasConflictResolutionType()  : mixed
hasEvictionMode()  : mixed
hasFlushEnabled()  : mixed
hasMaxExpirySecs()  : mixed
hasMinimumDurabilityLevel()  : mixed
hasNumReplicas()  : mixed
hasRamQuotaMb()  : mixed
hasReplicaIndexes()  : mixed
hasStorageBackend()  : mixed
setBucketName()  : $this
Generated from protobuf field <code>string bucket_name = 1;</code>
setBucketType()  : $this
Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>
setCompressionMode()  : $this
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>
setConflictResolutionType()  : $this
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>
setEvictionMode()  : $this
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>
setFlushEnabled()  : $this
Generated from protobuf field <code>optional bool flush_enabled = 5;</code>
setMaxExpirySecs()  : $this
Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>
setMinimumDurabilityLevel()  : $this
Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>
setNumReplicas()  : $this
Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>
setRamQuotaMb()  : $this
Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>
setReplicaIndexes()  : $this
Generated from protobuf field <code>optional bool replica_indexes = 6;</code>
setStorageBackend()  : $this
Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>

Properties

$bucket_name

Generated from protobuf field <code>string bucket_name = 1;</code>

protected mixed $bucket_name = ''

$bucket_type

Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>

protected mixed $bucket_type = 0

$compression_mode

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>

protected mixed $compression_mode = null

$conflict_resolution_type

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>

protected mixed $conflict_resolution_type = null

$eviction_mode

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>

protected mixed $eviction_mode = null

$flush_enabled

Generated from protobuf field <code>optional bool flush_enabled = 5;</code>

protected mixed $flush_enabled = null

$max_expiry_secs

Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>

protected mixed $max_expiry_secs = null

$minimum_durability_level

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>

protected mixed $minimum_durability_level = null

$num_replicas

Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>

protected mixed $num_replicas = null

$ram_quota_mb

Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>

protected mixed $ram_quota_mb = null

$replica_indexes

Generated from protobuf field <code>optional bool replica_indexes = 6;</code>

protected mixed $replica_indexes = null

$storage_backend

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>

protected mixed $storage_backend = null

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $bucket_name
@type int $bucket_type
@type int|string $ram_quota_mb
@type int $num_replicas
@type bool $flush_enabled
@type bool $replica_indexes
@type int $eviction_mode
@type int $max_expiry_secs
@type int $compression_mode
@type int $minimum_durability_level
@type int $storage_backend
@type int $conflict_resolution_type

}

Return values
mixed

clearCompressionMode()

public clearCompressionMode() : mixed
Return values
mixed

clearConflictResolutionType()

public clearConflictResolutionType() : mixed
Return values
mixed

clearMinimumDurabilityLevel()

public clearMinimumDurabilityLevel() : mixed
Return values
mixed

getBucketName()

Generated from protobuf field <code>string bucket_name = 1;</code>

public getBucketName() : string
Return values
string

getBucketType()

Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>

public getBucketType() : int
Return values
int

getCompressionMode()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>

public getCompressionMode() : int
Return values
int

getConflictResolutionType()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>

public getConflictResolutionType() : int
Return values
int

getEvictionMode()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>

public getEvictionMode() : int
Return values
int

getFlushEnabled()

Generated from protobuf field <code>optional bool flush_enabled = 5;</code>

public getFlushEnabled() : bool
Return values
bool

getMaxExpirySecs()

Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>

public getMaxExpirySecs() : int
Return values
int

getMinimumDurabilityLevel()

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>

public getMinimumDurabilityLevel() : int
Return values
int

getNumReplicas()

Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>

public getNumReplicas() : int
Return values
int

getRamQuotaMb()

Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>

public getRamQuotaMb() : int|string
Return values
int|string

getReplicaIndexes()

Generated from protobuf field <code>optional bool replica_indexes = 6;</code>

public getReplicaIndexes() : bool
Return values
bool

getStorageBackend()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>

public getStorageBackend() : int
Return values
int

hasConflictResolutionType()

public hasConflictResolutionType() : mixed
Return values
mixed

hasMinimumDurabilityLevel()

public hasMinimumDurabilityLevel() : mixed
Return values
mixed

setBucketName()

Generated from protobuf field <code>string bucket_name = 1;</code>

public setBucketName(string $var) : $this
Parameters
$var : string
Return values
$this

setBucketType()

Generated from protobuf field <code>.couchbase.admin.bucket.v1.BucketType bucket_type = 2;</code>

public setBucketType(int $var) : $this
Parameters
$var : int
Return values
$this

setCompressionMode()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.CompressionMode compression_mode = 9;</code>

public setCompressionMode(int $var) : $this
Parameters
$var : int
Return values
$this

setConflictResolutionType()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.ConflictResolutionType conflict_resolution_type = 12;</code>

public setConflictResolutionType(int $var) : $this
Parameters
$var : int
Return values
$this

setEvictionMode()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.EvictionMode eviction_mode = 7;</code>

public setEvictionMode(int $var) : $this
Parameters
$var : int
Return values
$this

setFlushEnabled()

Generated from protobuf field <code>optional bool flush_enabled = 5;</code>

public setFlushEnabled(bool $var) : $this
Parameters
$var : bool
Return values
$this

setMaxExpirySecs()

Generated from protobuf field <code>optional uint32 max_expiry_secs = 8;</code>

public setMaxExpirySecs(int $var) : $this
Parameters
$var : int
Return values
$this

setMinimumDurabilityLevel()

Generated from protobuf field <code>optional .couchbase.kv.v1.DurabilityLevel minimum_durability_level = 10;</code>

public setMinimumDurabilityLevel(int $var) : $this
Parameters
$var : int
Return values
$this

setNumReplicas()

Generated from protobuf field <code>optional uint32 num_replicas = 4;</code>

public setNumReplicas(int $var) : $this
Parameters
$var : int
Return values
$this

setRamQuotaMb()

Generated from protobuf field <code>optional uint64 ram_quota_mb = 3;</code>

public setRamQuotaMb(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setReplicaIndexes()

Generated from protobuf field <code>optional bool replica_indexes = 6;</code>

public setReplicaIndexes(bool $var) : $this
Parameters
$var : bool
Return values
$this

setStorageBackend()

Generated from protobuf field <code>optional .couchbase.admin.bucket.v1.StorageBackend storage_backend = 11;</code>

public setStorageBackend(int $var) : $this
Parameters
$var : int
Return values
$this

        

Search results