Class Site (0.4.0)

public final class Site extends GeneratedMessageV3 implements SiteOrBuilder

A physical site where hardware will be installed.

Protobuf type google.cloud.gdchardwaremanagement.v1alpha.Site

Implements

SiteOrBuilder

Static Fields

ACCESS_TIMES_FIELD_NUMBER

public static final int ACCESS_TIMES_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

GOOGLE_MAPS_PIN_URI_FIELD_NUMBER

public static final int GOOGLE_MAPS_PIN_URI_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NOTES_FIELD_NUMBER

public static final int NOTES_FIELD_NUMBER
Field Value
Type Description
int

ORGANIZATION_CONTACT_FIELD_NUMBER

public static final int ORGANIZATION_CONTACT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Site getDefaultInstance()
Returns
Type Description
Site

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Site.Builder newBuilder()
Returns
Type Description
Site.Builder

newBuilder(Site prototype)

public static Site.Builder newBuilder(Site prototype)
Parameter
Name Description
prototype Site
Returns
Type Description
Site.Builder

parseDelimitedFrom(InputStream input)

public static Site parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Site parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Site parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Site parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Site parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Site parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Site parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Site parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Site parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Site parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Site parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Site parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Site
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Site> parser()
Returns
Type Description
Parser<Site>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAccessTimes(int index)

public TimePeriod getAccessTimes(int index)

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TimePeriod

getAccessTimesCount()

public int getAccessTimesCount()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getAccessTimesList()

public List<TimePeriod> getAccessTimesList()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<TimePeriod>

getAccessTimesOrBuilder(int index)

public TimePeriodOrBuilder getAccessTimesOrBuilder(int index)

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
TimePeriodOrBuilder

getAccessTimesOrBuilderList()

public List<? extends TimePeriodOrBuilder> getAccessTimesOrBuilderList()

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

repeated .google.cloud.gdchardwaremanagement.v1alpha.TimePeriod access_times = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.gdchardwaremanagement.v1alpha.TimePeriodOrBuilder>

getCreateTime()

public Timestamp getCreateTime()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Site getDefaultInstanceForType()
Returns
Type Description
Site

getDescription()

public String getDescription()

Optional. Description of this Site.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of this Site.

string description = 25 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Optional. Display name of this Site.

string display_name = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of this Site.

string display_name = 24 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getGoogleMapsPinUri()

public String getGoogleMapsPinUri()

Required. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

string google_maps_pin_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The googleMapsPinUri.

getGoogleMapsPinUriBytes()

public ByteString getGoogleMapsPinUriBytes()

Required. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.

string google_maps_pin_uri = 6 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for googleMapsPinUri.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

map<string, string> labels = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNotes()

public String getNotes()

Optional. Any additional notes for this Site. Please include information about:

  • security or access restrictions
  • any regulations affecting the technicians visiting the site
  • any special process or approval required to move the equipment
  • whether a representative will be available during site visits

string notes = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The notes.

getNotesBytes()

public ByteString getNotesBytes()

Optional. Any additional notes for this Site. Please include information about:

  • security or access restrictions
  • any regulations affecting the technicians visiting the site
  • any special process or approval required to move the equipment
  • whether a representative will be available during site visits

string notes = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for notes.

getOrganizationContact()

public OrganizationContact getOrganizationContact()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContact

The organizationContact.

getOrganizationContactOrBuilder()

public OrganizationContactOrBuilder getOrganizationContactOrBuilder()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OrganizationContactOrBuilder

getParserForType()

public Parser<Site> getParserForType()
Returns
Type Description
Parser<Site>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. Time when this site was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasOrganizationContact()

public boolean hasOrganizationContact()

Required. Contact information for this site.

.google.cloud.gdchardwaremanagement.v1alpha.OrganizationContact organization_contact = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the organizationContact field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Time when this site was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Site.Builder newBuilderForType()
Returns
Type Description
Site.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Site.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Site.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Site.Builder toBuilder()
Returns
Type Description
Site.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException