public static final class APIKeySecurityScheme.Builder extends GeneratedMessage.Builder<APIKeySecurityScheme.Builder> implements APIKeySecuritySchemeOrBuilderAPIKeySecurityScheme defines an API key security scheme.
Protobuf type google.cloud.geminidataanalytics.v1beta.APIKeySecurityScheme
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > APIKeySecurityScheme.BuilderImplements
APIKeySecuritySchemeOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public APIKeySecurityScheme build()| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme |
|
buildPartial()
public APIKeySecurityScheme buildPartial()| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme |
|
clear()
public APIKeySecurityScheme.Builder clear()| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
|
clearDescription()
public APIKeySecurityScheme.Builder clearDescription()Optional. Description of this security scheme.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
clearLocation()
public APIKeySecurityScheme.Builder clearLocation()Optional. Location of the API key, valid values are "query", "header", or "cookie".
string location = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
clearName()
public APIKeySecurityScheme.Builder clearName()Optional. Name of the header, query or cookie parameter to be used.
string name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public APIKeySecurityScheme getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme |
|
getDescription()
public String getDescription()Optional. Description of this security scheme.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Optional. Description of this security scheme.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getLocation()
public String getLocation()Optional. Location of the API key, valid values are "query", "header", or "cookie".
string location = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The location. |
getLocationBytes()
public ByteString getLocationBytes()Optional. Location of the API key, valid values are "query", "header", or "cookie".
string location = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for location. |
getName()
public String getName()Optional. Name of the header, query or cookie parameter to be used.
string name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes()Optional. Name of the header, query or cookie parameter to be used.
string name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(APIKeySecurityScheme other)
public APIKeySecurityScheme.Builder mergeFrom(APIKeySecurityScheme other)| Parameter | |
|---|---|
| Name | Description |
other |
APIKeySecurityScheme |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public APIKeySecurityScheme.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public APIKeySecurityScheme.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
|
setDescription(String value)
public APIKeySecurityScheme.Builder setDescription(String value)Optional. Description of this security scheme.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public APIKeySecurityScheme.Builder setDescriptionBytes(ByteString value)Optional. Description of this security scheme.
string description = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
setLocation(String value)
public APIKeySecurityScheme.Builder setLocation(String value)Optional. Location of the API key, valid values are "query", "header", or "cookie".
string location = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe location to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
setLocationBytes(ByteString value)
public APIKeySecurityScheme.Builder setLocationBytes(ByteString value)Optional. Location of the API key, valid values are "query", "header", or "cookie".
string location = 2 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for location to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
setName(String value)
public APIKeySecurityScheme.Builder setName(String value)Optional. Name of the header, query or cookie parameter to be used.
string name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public APIKeySecurityScheme.Builder setNameBytes(ByteString value)Optional. Name of the header, query or cookie parameter to be used.
string name = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
APIKeySecurityScheme.Builder |
This builder for chaining. |